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 starter guide wordt stap voor stap uitgelegd hoe je de NS API's kunt gebruiken.

Registratie

Voordat je de beschikbare API’s en Producten kunt zien heb je een account nodig.

  •  Ga naar de Inlog/Registreer pagina

  •  Klik op de juiste button: NS Medewerker of Externe bezoeker

  •  Vul, als er naar gevraagd wordt, de gegevens in.

  •  Verstuur het formulier.

Je ontvangt een automatische e-mail waarin staat dat de registratie is voltooid. Let op: het kan een aantal minuten (max 5) 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. Lees hieronder hoe.

Product + (subscription) key

Een product is een bundel van één of meerdere API’s. Welke producten er allemaal zijn, vind je hier.

Toegang tot een API wordt ook geregeld via een product. Om toegang te krijgen tot een API, en er vervolgens gebruik van te kunnen/mogen maken, heb je een abonnement sleutel (= subscription key) nodig. Zie deze sleutel/key als je persoonlijke toegangs-, en identificatiesleutel tot de API. De toegang (en dus sleutel) vraag je aan via het product. Het wordt dan ook de product subscription key genoemd. Hieronder lees je de stappen om een (subscription) key te bemachtigen:

  1. Ga naar het product waaronder de API aangeboden wordt. Dit kan via de routes:

    1. Via de producten pagina en klik op het gewenste product. Kies deze route als je al het product weet waaronder de API aangeboden wordt.

    2. Via de API pagina. Selecteer het product linksonder op de API pagina onder 'Related Products'. Dan wordt je gelijk doorgelinkt naar de betreffende product pagina.

  2. Onder het kopje 'jouw subscriptions' (kan in het Engels getoond worden) zie je of je al een subscription hebt, en zo niet dan kan je er een aanvragen via de Subscribe button. Let op, deze staat in eerste instantie nog uit.

    Om een subscription aan te vragen doe het volgende

    • Ga akkoord met de eventuele gebruikersvoorwaarden (als de voorwaardenlink / selectiebox niet zichtbaar is dan zijn er geen voorwaarden opgesteld).

    • Vul een naam in voor je subscription. Advies: vul de naam in van het product, maar je mag hier naar believen van afwijken. Deze naam zal ook te zien zijn op je profiel pagina binnen de sectie 'Abonnementen'.

    • De Subscribe knop/button zal nu actief zijn. Klik op Subscribe om de aanvraag in te schieten.

      Je wordt vervolgens 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 beoordelen, hiervan krijg je zo snel mogelijk bericht.

Product (subscription) key

Zodra je (subscription) aanvraag is goedgekeurd vind je op je profiel pagina de toegewezen persoonlijke subscription key. Deze key dien je tijdens elke request(bericht) mee te sturen. Je kunt op de Try-It pagina van de API (operation) zien hoe de key als Header meegegeven dient te worden.

Er kunnen nog extra beveiligingstoepassingen actief zijn om de API (operatie) succesvol te kunnen aanroepen. Mocht dit het geval zijn dan zul je deze zien op de API pagina / definitie, of te horen krijgen van de API eigenaar.

Specifieke product/API vragen?

Mocht je Product of API vragen/verzoeken/opmerkingen hebben, stel ze via het formulier onderaan op de Product pagina. Je vraag wordt via dit formulier (op deze pagina) bij de eigenaar van de API/Product afgeleverd en hij/zij zal (waar nodig) contact met je opnemen.

Meer informatie over API’s

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