Login to NxtPort

Login with your NxtPort account or register to see more information of this community

 

Login with your account
Register a new account

Before your start

Summary

To access the NxtPort API's, the following information is needed: 

  • A client ID and its corresponding secret, used to authenticate the application or software that is performing the request
  • A username and password of a user, belonging to a registered company, that has an active subscription to an API or Use Case
  • An API or subscription key, belonging to the entity that is performing the request, used to authorize the entity
  • For some use cases, the role of the user (defined within the portal, eg Admin) is also used to manage access to API requests.
  • For some API's, NxtPort provides two environments. A UAT/Testing environment and a Production environment. Each environment has its own setup requirements. You can read more detailed information in the documentation UAT/Testing vs Production

Request a Client & Secret

A client is used to identify the application or software that is trying to connect to the NxtPort platform. If you are using a software that already has an active integration with NxtPort, please verify with your vendor if they required a specific client & secret for your account. If not, you can skip this step.

All other parties that wish to integrate a NxtPort API (either as a 3rd party software vendor or as a developer that works for a company registered on NxtPort) need to request a client & secret.

To request a client, please create a support ticket via our ticketing tool or send an email to support@nxtport.com.

Create an (API) user

In order to access the API's of NxtPort and request your token, you will need a user account and corresponding password. Users are created within the NxtPort console. Should you require more information on how to setup users within your entity, please refer to the provided documentation on this topic. 

Remark

It is possible to use the admin account that was created when the entity was registered. We however suggest to create a specific user to prevent issues when passwords are forgotten as this might break the connection towards the NxtPort platform. 

Subscribe to 1 (or more) use cases

In order to integrate an API, you will first need to subscribe to that API. You can find all our available API's on our marketplace. Once you have subscribed to an API and the access request was approved by the API owner, you will be able to retrieve an API key from the NxtPort console. This API key is required authorise the requesting party and return data. 

 

Connect to NxtPort

Authentication

Once you have obtained your client/secret and user/password combinations, you can use the below information to request a token which is used for the authentication of your request. This allows the NxtPort platform to validate if the requesting entity has an active registration to the NxtPort platform.

To retrieve your bearer/JWT token, send a POST request to https://login.nxtport.com/connect/token (or https://login-uat.nxtport.com/connect/token for the test environment) with the following body in form-urlencoded format:

  • username: E-mail address of the (API) user
  • password: Password of the (API) user
  • grant_type: password
  • client_id: Your client
  • client_secret: Your client secret
  • scope: openid (for some use cases, this scope is different)

The access token will be in the access_token field of the response. It is valid for 24 hours. A token is about 4000 characters long.

Below you can see a screenshot from postman on how the fields need to be sent

The response will look like the below json file: 

 

{
    "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkFGMEQyND[...]Bg_zsqYxKnYTUgKFA",
    "expires_in": 86400,
    "token_type": "Bearer",
    "scope": "openid profile"
}
Field Type Comment
access_token string The bearer token that is needed to authenticate your software or system to make API calls to the NxtPort platform 
 expires_in time The number of seconds your token is valid. Can be used to identify when a refresh of the token is required. Depending on the scope, the token will default to 24hours. 
token_type string Bearer
scope string The scope for which the token is granted. Depending on the use case, different scopes may be required. Your client needs to be allowed to request the scope. For more information on scopes, please create a support ticket. 

 

Authorization

In order to call one of our API's follow the below steps (unless otherwise mentioned in the specific documentation):

  • Include the API key of the stakeholder in your call: You can put the API subscription key either in the header as the Ocp-Apim-Subscription-Key parameter, or in the query string as the subscription-key parameter. This key is found in the NxtPort Console
  • Include the JWT token (see Authentication) in your call using a header parameter with name “Authorization" and value “Bearer {TOKEN}”. Replace {TOKEN} with the token that you received in your call to get the token and remove the quotes, present here just to indicate the extent of the content. The authorization token is created using the client key of the application builder.
  • External software developers will need to use the API key of a subscribed stakeholders for which they are integrating as they will not be approved by the API owners when subscribing (unless otherwise defined within the Use Case)

Below you can see a screenshot from postman on how the fields need to be sent

 

Base URL's

NxtPort has different environments. As each of the environments stands completely separate from the other ones, it is required to request tokens, subscribe, ...for each of those that you want to connect. 

In the specific API documentation, we often refer to the "baseURL" in orde to reduce the complexity of the pages:

 

Integrate our API's

You are now set to go. Please follow the provided documentation for every API and integrate your software with the NxtPort API's. Should you have any questions, don't hesitate to create a support ticket via our ticketing tool or send an email to support@nxtport.com. 

 

Book a digital coffee