API URL
URL https://api.korte.link/v1/<FUNCTIE>/{PARAMS}
Methode GET = Opvragen, POST = Aanmaken, DELETE = Verwijderen, PUT = Controleren
FUNCTIE Functie die uitgevoert moet worden.
PARAMS Extra parameters voor de API REQUEST
 
X-APIKEY Deze key word eenmalig op verzoek verstrekt. eventueel gebonden aan een vast ip adres
API functies
FUNCTIE Methode PARAMS Omschrijving Return
Link POST <URL> Maak een nieuwe verkorte link String 6 karakters
Link DELETE <LINK> Verwijder verkorte link Boolean true / false
Link PUT <LINK> Controleer of verkorte link bestaat Boolean true / false
Link GET <LINK> Decode verkorte link String complete URL
Link GET NULL Weergave alle linken van gerbruiker JSON array complete URL's
 
File POST <FILE> Upload een bestand en maak een verkorte link String 6 karakters
File DELETE <LINK> Verwijder bestand Boolean true / false
File GET <LINK> Download bestand + verwijder String bestand
File GET NULL Weergave alle bestanden van gebruiker String bestand
 
Stat GET <LINK> Weergave hoevaak een link gebruikt is Integer positief getal
Stat GET NULL Weergave hoevaak alle linken van gebruiker gebruikt zijn JSON array alle stats
 
Algemene error return String error melding
API Uitleg

De API is een zogenaamde RESTful API en maakt gebruik van get/post/put en delete HTTP requests.
Alle retour waardes zijn van het type string / boolean / interger of een JSON array.

Let er op dat alle parameters urlencoded zijn.

PHP cURL voorbeeld
01 | <?php
02 | $headers 
= array('X-APIKEY: 9afc25c6be9270a523250992d0ae1b6f');
03 |
$url "https://api.korte.link/v1";
04 |
$resource "/<functie>/{param}";
05 |
06 |
$curl curl_init();
07 |
08 |
curl_setopt($curlCURLOPT_URL$url $resource);
09 |
curl_setopt($curlCURLOPT_HTTPHEADER$headers);
10 |
11 |
// voor een POST request:
12 |
curl_setopt($curlCURLOPT_POSTtrue);
13 |
// voor een DELETE request:
14 |
curl_setopt($curlCURLOPT_CUSTOMREQUEST'DELETE');
15 |
// voor een PUT request:
16 |
curl_setopt($curlCURLOPT_PUTtrue);
17 |
// voor een GET request:
18 |
curl_setopt($curlCURLOPT_HTTPGETtrue);
19 |
20 |
21 |
curl_setopt($curlCURLOPT_RETURNTRANSFERtrue);
22 |
curl_setopt($curlCURLOPT_SSLVERSIONCURL_SSLVERSION_TLSv1_2);
23 |
curl_setopt($curlCURLOPT_SSL_VERIFYHOSTtrue);
24 |
curl_setopt($curlCURLOPT_SSL_VERIFYPEERtrue);
25 |
26 | if(!
$xml curl_exec($curl)) die('Error: "' curl_error($curl) . '" - Code: ' curl_errno($curl));
27 |
curl_close($curl);
28 |
29 |
print_r($xml);
30 |
?>