Starter's Guide

Welkom bij het API-Portaal van NS! NS biedt een verzameling van API's aan waarmee je onze services kunt integreren in jouw applicaties. Deze pagina zal je voorzien van informatie om de API’s aan te kunnen roepen.

In de starters guide wordt stap voor stap uitgelegd hoe je de NS API's kunt gebruiken.
Registratie
Voordat je gebruik kan maken van de API’s heb je een account nodig.

Je ontvangt een automatische e-mail waarin staat dat de registratie is voltooid. Let op: het kan een aantal minuten duren voordat je de beschikbare API’s kunt zien in het portaal.
API’s
In het API overzicht zie je een lijst van beschikbare API’s. Daarnaast is een korte omschrijving van de API weergegeven. Met behulp van de zoekbalk kan je zoeken naar de voor jou relevante API. Iedere API is voorzien van uitgebreide documentatie (parameters, voorbeeld request).

Wil je gebruik maken van de API? Vraag dan toegang aan via het product.
Producten
Een product kan bestaan uit één of meedere API’s. Welke producten er allemaal zijn vind je hier.
Om gebruik te kunnen maken van een API heb je een key nodig.

  • Ga naar de productenpagina
  • Klik op het gewenste product
  • Klik op Abonneren
  • Ga akkoord met de eventuele gebruikersvoorwaarden en klik op bevestigen

Je wordt geleid naar je persoonlijke profiel pagina waar je de status van de aanvraag kan vinden. Daarnaast krijg je een automatisch gegenereerde e-mail met een bevestiging van je inschrijvingsverzoek op dit product.
Indien goedkeuring van het abonnement vereist is zal de eigenaar van de API je verzoek zo snel mogelijk keuren, hiervan krijg je zo snel mogelijk bericht
Gebruik van de API

Zodra je bericht hebt gehad dat je succesvol een abonnement hebt afgesloten, kan je aan de slag met de API

  • Klik op je naam rechts bovenin het scherm
  • Kies voor profiel om een overzicht te zien van jou abonnementen
  • Ieder product heeft een unieke key (primary of secundary), neem deze key over in de request header om een succesvolle API
    request uit te voeren

Het gebruik van de API’s is gratis. Er is wel een limiet aan het aantal calls dat uitgevoerd mag worden. Dit verschilt per product. NS heeft altijd de mogelijkheid om het limiet aan te passen als dit gewenst is.

Meer informatie over API’s
Onderstaande video geeft je in een paar minuten een beeld van hoe API's werken.

Heb je vragen?

Hier staan de meest gestelde vragen, staat je vraag er niet tussen? Neem dan via het contactformulier contact met ons op

Heb je vragen over een API of product? Neem dan contact op met de eigenaar.

  • Ga naar de productenpagina
  • klik op het product waar jij een vraag over hebt
  • Klik op contact en vul het formulier in
  • Verstuur het formulier door te klikken op indienen

Het gebruik van de API’s is gratis. Er is wel een limiet aan het aantal calls dat uitgevoerd mag worden. Dit verschilt per product. NS heeft altijd de mogelijkheid om het limiet aan te passen als dit gewenst is.