Market

group

About the Market

The NxtPort Market is the place to subscribe to our API's, or Apps in a later phase. There are two ways you can subscribe to API's or Apps: as a data consumer, or as an ISV (Independent Software Vendor).

Market APIs

Go to the Market

MARKET

What are API's?

NxtPort's core activity is gathering data from various sources in the supply chain. An API (or 'Application Programming Interface'), is the final result of this process. This is a service that allows data to be requested and returned in a uniform way. For example, there could be an API that gives the user the ETA of a ship when he inputs the right details about the ship.

group

Use the Market as Data Consumer

Live vs Sandbox

Live and Sandbox

Live API’s are the ones you are looking for. Those are the API’s who are actually working with real-life data. 


Sandbox API’s are of no use for a data consumer. 

Direct Access API's vs Access Controlled API's

Direct Access APIs
Direct Access API's do not require data sharing. Registering for these API's is easy and fast. Once your company and yourself are registered, all you need to do is subscribe to one of the API's that you find in the Market and you are good to go. There will be an API key available that grants you access to the available data in the API. (In Direct Access API’s, the data consumer will be the same instance as the ISV in most cases, because there will be no third party app between the data and the systems of the data consumer)



Access Controlled APIs
For Access Controlled API's, the application user, i.e. the data consumer, 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.
group

Use the Market as ISV

Live vs Sandbox

Live and Sandbox

The sandbox is an environment identical to the live environment, but with dummy data. The aim is to provide a safe and free environment to develop and test applications, before using them on live data. It must be possible to move from sandbox to live without any changes, so the sandbox will apply the same security and data sharing principles as those applied to live data. This means that you, as a developer, need to:


  - Subscribe to the sandbox API, which will give you access to the sandbox data. Just as your application user would subscribe to the live API, in order to access the live API's data.
  - Register your application in the NxtPort platform, so that your application can access the sandbox API. This allows you to test the full OAuth2 authentication flow. This registration will also work for the live environment, it just needs to be activated for live data when your application is ready.

Direct Access API's vs Access Controlled API's

Direct Access APIs

Direct Access API’s have no specific sharing control and there is no need to implement a full authentication flow. The only thing you need is an API key to add to the header of your API call. You can get that key by subscribing to the API. API usage is metered and billed based on this API key. If usage should be billed to the users of your application, you should ask those users to bring their own key. More information is available in the documentation tab in the Market.


Access Controlled APIs

If an API is Access Controlled, 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. More information is available on the OAuth2 for ISV's page.