Aan de slag met het open dataplatform van Port of Antwerp-Bruges

Als je de API's die beschikbaar zijn op het Open dataplatform wil implementeren, moet je een aantal stappen doorlopen voor je toegang krijgt tot de data. 

Die stappen gelden voor alle gebruikers, zowel bedrijven als individuele gebruikers. Als je vragen hebt over dit onderwerp, neem dan contact op met NxtPort Support.

Wie gebruik wil maken van de Open Data API's moet zich registreren op het Open dataplatform. 

Bedrijven of gebruikers die de Open Data API's willen gebruiken, moeten een account aanmaken. 

1. Ga naar de website van NxtPort en vul de gevraagde informatie in. 
2. Je ontvangt via mail een link, klik erop om je registratie te bevestigen. Als je de mail niet hebt gekregen, kijk dan eens in je junkmail. Als de link niet werkt of je geen e-mail hebt ontvangen, maak dan een supportticket aan.

Op het Open dataplatform vind je een set API's die je in je eigen applicatie kunt integreren. 

De API's komen met een link om je te abonneren, die je naar het tabblad "Data user" in de console brengt. Klik in de tab "Subscribe" op de knop "Subscribe". Indien specifieke toegang voor de API vereist is, wordt dit vermeld. 

Als je op "Subscribe" hebt geklikt, word je doorgestuurd naar de abonneerpagina's van NxtPort. Om naar deze pagina's te gaan, moet je eerst inloggen met de NxtPort-referenties die je in de vorige stap hebt aangemaakt. Na het inloggen moet je een omgeving selecteren: Live = reële gegevens, Sandbox (indien beschikbaar) bevat dummygegevens. Als je de omgeving hebt geselecteerd, moet je mogelijk je rol identificeren. 

Tot slot moet je de Algemene Voorwaarden voor de API aanvaarden.

Klik op "Save" en je wordt naar een bevestigingspagina geleid. Je bent nu met succes geabonneerd op je eerste API.

Zodra je bedrijf geregisteerd is, maak je via mail (support@nxtport.com) of via het ticketingportaal een supportticket aan om je Client Key aan te vragen. Ons supportteam helpt je met de verschillende omgevingen en het instellen van de Client ID's voor je organisatie. Bij API-verzoeken zijn een Client Key en bijbehorend Secret nodig om je organisatie te authenticeren.

Om de Open Data API's te gebruiken, moet je Oauth2-authenticatie instellen. Zodra je de noodzakelijke client-gegevens hebt ontvangen en je gebruikersnaam hebt, kun je een verbinding opzetten met behulp van de volgende parameters:

• gebruikersnaam: e-mailadres van de API-gebruiker (van een stakeholder, geen softwareontwikkelaar) die op de API is geabonneerd
• wachtwoord: wachtwoord van de API-gebruiker
• grant_type: wachtwoord
• client_id: Client ID van de applicatiebouwer (intern of derde), door NxtPort verstrekt aan de softwareontwikkelaar (niet aan de stakeholders)
• client_secret: code om de client_id te verifiëren, eveneens door NxtPort verstrekt aan de softwareontwikkelaar (niet aan de belanghebbenden)
• scope: openid

Je kunt bovenstaande informatie gebruiken om een toegangstoken aan te vragen, die 1 uur geldig is, door te gaan naar https://login.nxtport.com/connect/token (productie) of https://login-uat.nxtport.com/connect/token (UAT). Dit token heb je nodig om API's op te vragen.

Om een web-API op te vragen:

• moet je de API Key opnemen in je verzoek: je kunt de API-abonnementskey in de hoofding zetten als de parameter Ocp-Apim-Subscription-Key, of in de query string als de parameter 'subscription-key'. Deze code is te vinden in NxtPort Console (link UAT, link productie).
• neem het token in je verzoek op met behulp van een hoofdingparameter met de naam "Authorization" en de waarde "Bearer {TOKEN}". Vervang {TOKEN} door het token dat je hebt ontvangen in je authenticatievraag en verwijder de aanhalingstekens om de omvang van de inhoud aan te geven. Het autorisatietoken wordt aangemaakt met behulp van de Client Key van de applicatiebouwer.

Externe softwareontwikkelaars moeten de API Key gebruiken van de geabonneerde stakeholders waarvoor ze integreren.

Indien van toepassing moeten de volgende IP-adressen op de witte lijst gezet worden:

• UAT: 20.76.52.43
• Productie: 20.76.217.177