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

Dit document beschrijft de stappen die u moet doorlopen voordat u gebruik kunt maken van de API's die beschikbaar zijn op het Open dataplatform. Merk op dat we gebruik maken van het platform NxtPort om onze API's te delen en daarom de procedures en ISO-praktijken volgen die van toepassing zijn binnen de organisatie NxtPort.

Getting started

Bij het implementeren van de API's die beschikbaar zijn op het Open dataplatform, moet een aantal stappen worden doorlopen voordat toegang tot de gegevens kan worden verkregen. 

 

Deze stappen gelden voor alle gebruikers, zowel bedrijven als individuele gebruikers. Mocht u vragen hebben over dit onderwerp, neem dan contact op met de NxtPort Support.

Ondersteuning NxtPort

Accountregistratie

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 registreren. 

  1. Ga om te registreren naar de website van NxtPort en vul de gevraagde informatie in. 
  2. U ontvangt in uw mailbox een link, waarop u klikt om uw registratie te bevestigen. Ontving u die e-mail niet, controleer dan uw SPAM-map. Als de link niet werkt of u geen e-mail hebt ontvangen, maak dan een supportticket aan.
Registreer uw account

Abonnement op uw eerste API

Op het Open dataplatform vindt u een set API's die u kunt integreren in uw eigen applicatie. 

 

De abonnementslink die met de API's wordt geleverd, brengt u naar het tabblad "Gegevensgebruiker" in de console. In het tabblad "Abonneren" klikt u op de knop "Abonneren". Indien specifieke toegang voor de API vereist is, wordt dit vermeld. 

 

Nadat u op de knop "Abonneren" hebt geklikt, wordt u doorgestuurd naar de NxtPort Abonnementspagina's. Om op deze pagina's te geraken, moet u eerst inloggen met de NxtPort-referenties die u in de vorige stap hebt aangemaakt. Na het inloggen wordt u gevraagd een omgeving te selecteren: Live = reële gegevens, Sandbox (indien beschikbaar) bevat dummygegevens. Na het selecteren van de omgeving moet u mogelijk uw rol identificeren. 

 

Tot slot moet u de "Algemene voorwaarden" voor de API accepteren.

 

Na het klikken op de knop "Opslaan" wordt u doorgestuurd naar een bevestigingspagina. U bent nu met succes geabonneerd op uw eerste API.

Vraag uw klant ID & geheim aan

Zodra de registratie van uw bedrijf voltooid is, maakt u per e-mail (support@nxtport.com) of via het ticketingportaal een supportticket aan om uw cliëntcode aan te vragen. Ons supportteam helpt u met de verschillende omgevingen en het instellen van de client-ID's voor uw organisatie. Bij het doen van API-verzoeken zijn een Client Key en bijbehorend Secret nodig om uw organisatie te authenticeren.

Authenticatie en autorisatie

Authenticatie

Om de Open Data API's te kunnen gebruiken, moet u Oauth2-authenticatie instellen. Zodra u de noodzakelijke klantinformatie hebt ontvangen en u uw gebruikersnaam hebt, kunt u 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: klant-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

U kunt bovenstaande informatie gebruiken om een toegangstoken aan te vragen, geldig voor een periode van 1 uur, door te gaan naar https://login.nxtport.com/connect/token (productie) of https://login-uat.nxtport.com/connect/token (UAT). Dit token is vereist om met succes API's op te vragen.

Toelating

Om een web-API op te vragen:

  • neem de API-sleutel op in uw verzoek: u kunt de API-abonnementscode in de hoofding zetten als de parameter Ocp-Apim-abonnementscode, of in de query string als de parameter abonnementscode. Deze code is te vinden in NxtPort Console (link UATlink productie).
  • neem het token in uw verzoek op met behulp van een hoofdingparameter met de naam "Authorization" en de waarde "Bearer {TOKEN}". Vervang {TOKEN} door het token dat u hebt ontvangen in uw authenticatievraag en verwijder de aanhalingstekens om de omvang van de inhoud aan te geven. Het autorisatietoken wordt aangemaakt met behulp de cliëntsleutel van de applicatiebouwer.

Externe softwareontwikkelaars moeten gebruik maken van de API-sleutel van de geabonneerde stakeholders waarvoor ze integreren.

IP-adressen voor positieve lijst

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

  • UAT: 20.76.52.43
  • Productie: 20.76.217.177

Ondersteuning

Mocht u vragen hebben over de implementatie van de API's die beschikbaar zijn op het Open dataplatform, neem dan contact op met NxtPort Support.

Ondersteuning krijgen
Contact Open Data Platform support for any questions about the Open Data Platform API's.

Dit vindt u mogelijk eveneens interessant