Below you can find different guidelines for stakeholders that wish to integrate the Certified Pick up API into their systems. These documents are updated on a request base. Should you require additional documentation to align for your business process, don't hesitate to contact us through our Service desk.
Certified Pick up will bean obligatory process to integrate into your processes for all stakeholders involved in the import of containers in the Port of Antwerp. As a stakeholder, there are multiple ways to join:
The Certified Pick up case offers two separated environments for the API integration: a production environment for Live data and a User Acceptance environment for integration setup and testing.
This allows you to test your API-integration prior to linking your production environment. However, unlike most sandbox or user acceptance environments that work independent of other stakeholders while integrating, the Certified Pick up use case is a process that involves several stakeholders. It requires input from other relevant involved parties. As such, please make sure that the other companies you wish to integrate with are aware that you will be sending test data through the User Acceptance environment.
If you wish to use our UAT/testing environment, please send a request to email@example.com and we will provide you with the necessary information.
CPu Documentation pages
When implementing the Certified Pick up API, a number of steps need to be taken before access can be obtained.
Remark: This applies to all entities that wish to start using the Certified Pick up application. In case you have previously registered your company on the NxtPort platform you will need to register again via C-point. For further questions or assistance, please contact NxtPort support.
Any stakeholder that wants to use the Certified Pick up API needs to be registered on the C-point platform.
If these links are not working for you, please create a support ticket.
Any stakeholder that wants to use the Certified Pick up API needs to subscribe to the application on the C-Point platform and sign the relevant terms & conditions.
Subscribers can have multiple roles. You will need to choose the role that fits with your profile. Your subscription will be verified and approved by the Certified Pick up team.
Subscription is done via the C-point dashboard. You can follow the second part of this tutorial.
Once the registration of your company is completed, please create a support ticket via e-mail (firstname.lastname@example.org) to request the necessary Client Key. Our support team will help with the different environments and setting up the client ids for the Certified Pick-up API.
API-users are created within the NxtPort console. User accounts of C-point cannot be used for API calls via the NxtPort platform. To create users within the NxtPort console, follow these steps:
You can find a detailed description of the steps on the User management tutorial.
In order to use the API’s, you need to setup Oauth2 authentication. When you have received the necessary keys from NxtPort, you will be able to setup a connection with the following parameters:
Example of a setup in postman is shown in the below image. Be sure to select the x-www-form-urlencoded format.
With the above information you can request an access token, valid for a period of 1 hour, via https://login.nxtport.com/connect/token (production). This token is required to make successful API calls.
In order to call a web API:
Certified Pick up uses an asynchronous notification mechanism using HTTP post end points.
When integrating the use case with an API integration, this is an essential step in order to receive the required information from other stakeholders.
After you create your channel(s) you also need to link them to the Certified Pick up application.
For further information on how to setup your notification channels, please refer to the corresponding tutorial.
For UAT environment links please contact NxtPort support