"Een API is zo goed als zijn documentatie"

API Documentatie (Versie 1)


Bekijk hieronder hoe je de API van iservertraging.nl kunt gebruiken.


Inhoudsopgave


Gebruik van de API

De API is door iedereen vrij om te gebruiken. Je mag zoveel aanroepen doen als je wilt. Lijkt het erop dat je hier misbruik van maakt, dan schromen we niet om je toegang tot de API te ontnemen.
Hieronder lees je hoe een gemiddelde API aanroep eruitziet en wat voor antwoord je terug kunt verwachten.


Formaat van de request

Een API aanroep is altijd van het volgende formaat:
GET http://iservertraging.nl/api/v1/{uri}


Formaat van de response

Versie 1 van de API geeft enkel antwoorden terug in het JSON formaat.


Beschikbare aanroepen


Is er vertraging?

Deze aanroep vertelt je of er momenteel vertragingen zijn bij de NS. Zijn er vertragingen, dan krijg je als antwoord true. Zijn er geen vertragingen dan krijg je als antwoord false.

Request

Een voorbeeldaanroep ziet er als volgt uit:
GET http://iservertraging.nl/api/v1/is-er-vertraging

Response

Een response kan er als volgt uitzien:
true of false

Je kunt het zelfs proberen in je browser! Je hoeft enkel naar de volgende url te gaan:
http://iservertraging.nl/api/v1/is-er-vertraging


Voorbeeldcode


PHP Voorbeeld

<?php
// is-er-vertraging.php
define("ENTRYPOINT", "http://iservertraging.nl/api/v1");
$jsonResponse = file_get_contents(ENTRYPOINT."/is-er-vertraging");
$response = json_decode($jsonResponse);
if($response === true) {
    echo "Ja, er is momenteel vertraging bij de NS.";
} else {
    echo "Nee, er is momenteel geen vertraging bij de NS.";
}