Application user / data user

This Data API is an access-controlled API. This means that the application user, i.e. the data user, needs to be identified in order to receive data from the API, and that he will only receive the information that is shared with the organisation that he is part of.

To be able to use an access-controlled API:

• The user and the organisation he belongs to need to register on the NxtPort platform.
• The user's organisation needs to be subscribed to the API. The organisation's admin can do this by selecting one of the API's price plans.
• Data sharing needs to be set up. This is automatically triggered by the subscription but currently includes some manual checks, which may take up to 1 working day to complete and/or may involve NxtPort contacting your for more information.

When the set-up is complete, the application user logs in to the application with his NxtPort account. The application calls the NxtPort API on behalf of that account.

Steps to take:

• Subscribe to the API by clicking on ‘Subscribe’
• Each user needs to register here on the marketplace (click register on the top right menu)

Data provider

Any party that determines containers weights can provide this data to the NxtPort platform and share it with others in the supply chain. The API currently supports only actual weighings, but calculated weights will soon be implemented. NxtPort is also developing an API that provides container tarra weights, as useful piece of information for those applying the calculation method. Feel free to contact us for further information. 

To start sharing your data, contact NxtPort. We will make it easy for you to get your data on the platform and start sharing it through the API. You stay at all times in control of which parties can access your data, and we provide a full audit trail of who has consulted which of your data.

Developer

This API is an access-controlled API. This means that your application needs to accommodate an OAuth2 authentication flow between the application user and the NxtPort platform.

The application user logs in to the NxtPort identity component, and your application requests access to the API on behalf of the application user. The NxtPort platform then returns an access token to your application, which can be used to call the API.

To be able to request an access token, your application needs to be registered in the NxtPort platform. Registering an application is currently a manual process, so please contact NxtPort for this. Go to our support desk where you will find all required information on how to get started.