API: versie 3

Op deze pagina is de documentatie te vinden voor versie 3 van de vertraagd.com API.

De API biedt gegevens aan in XML- of JSON-formaat. Je vraagt gegevens op door een variant van de volgende URL te gebruiken:

https://api.vertraagd.com/3/KEY/DATA/VERVOERDER/OUTPUT



We bespreken alle dikgedrukte onderdelen stuk voor stuk. Aan het eind van dit document staan de foutmeldingen die je kunt verwachten als er iets misgaat.

HTTPS

Vanaf versie 3 van de API is het gebruik van HTTPS verplicht. Omdat je key zichtbaar is in de url, is het veiliger om via een beveiligde verbinding met onze API te praten. Als je versie 3 via HTTP probeert te bereiken, krijg je een foutmelding.

KEY

Dit is simpel. Hier vul je de API key in die je bij het aanmelden hebt gekregen. Bescherm deze key met je leven. Het is je sleutel tot de vertraagd.com API.

DATA

Hier vertel je onze server welke gegevens je wilt ontvangen. Er zijn een paar verschillende typen data die je kunt opvragen.

actueel: de huidige status op het spoor. Hoeveel procent rijdt nu op tijd en hoeveel treinen zijn vertraagd of uitgevallen? Dit is de data die versie 2 van de API ook gaf

gisteren: hoeveel procent van de treinen reed gisteren op tijd? Dit is het dagpercentage dat we op de site melden

maand: hoeveel procent van de treinen reed vorige maand op tijd? Dit is het maandpercentage dat we op de site melden

ranking: welke vervoerder presteerde gisteren het beste? De elementen zijn gerangschikt van hoog naar laag. Dit is de ranking die we op de site melden

VERVOERDER

In deze nieuwe versie geven we je ook data per vervoerder. Geldige waarden zijn de namen van alle vervoerders (ns, arriva, qbuzz, keolis, connexxion, breng, nsinternational, abellio) en de vervoerder all, voor gegevens over het hele spoornet.

(Gegevens van R-net zijn vanaf december 2018 beschikbaar onder de naam Abellio, vanaf december 2018 is Qbuzz toegevoegd. Gegevens van Syntus zijn vanaf december 2017 beschikbaar onder de naam Keolis)

OUTPUT

Je kunt de gegevens uit onze API in twee formaten krijgen: XML en JSON. Om te kiezen, voeg je gewoon xml of json (beide lowercase) toe aan het eind van de url. Deze parameter is verplicht, er is geen fallback naar eens standaardwaarde.


Vraag toegang aan

Foutmeldingen

We hopen natuurlijk dat je zo min mogelijk foutmeldingen te zien krijgt. Maar als het toch gebeurt, dan kun je hieronder lezen wat ze betekenen.

ERROR 403: Ongeldige API-key of gebruiker geblokkeerd. Deze foutmelding geeft aan dat je API key niet geaccepteerd is. Dit kan komen door een typfout of omdat we je geblokkeerd hebben. Kopieer de key vanaf de site, op de pagina waar je toegang krijgt. Kom je er niet uit, stuur een mail naar [email protected]

ERROR 404: API-Functie niet gevonden. Deze foutmelding krijg je als de URL niet klopt. Het kan zijn dat je een waarde hebt gebruikt die niet bestaat. Ook als je een waarde bij OUTPUT weglaat, krijg je deze foutmelding.

ERROR 405: Ongeldige output gekozen. Alleen 'xml' en 'json' worden ondersteund. Deze foutmelding spreekt voor zich. Je kunt alleen xml of json kiezen als output.

ERROR 426: Versie 3 van de API vereist het gebruik van HTTPS. Maak verbinding via https://api.vertraagd.com/.. Bij versie 3 van de API is verbinding via HTTP niet meer toegestaan. Verander HTTP aan het begin van de URL in HTTPS en het zou moeten werken.

ERROR 409: Geen toegang tot APIv2. Alleen voor gebruikers die op 1 januari 2018 al geregistreerd waren. Deze foutmelding wordt alleen gegeven bij gebruik van versie 2 van de API. Die versie is alleen nog te gebruiken voor gebruikers die op 1 januari 2018 al geregistreerd waren.

92%
van 112 treinen rijdt nu op tijd
  
OVER ONS
vertraagd.com laat zien hoeveel procent van de treinen in Nederland op tijd is
Lees hier meer