You will find several API's and use-cases in the marketplaces of the communities. In order to connect to an API a number of steps will be required. The easiest are the subscription to an API. Some other steps are pure technical to establish a secure machine-to-machine connection to the subscribed API. More information about the technical set-up of client-id's and client secrets are published in this "configuring your machine-to-machine connection for API's" article.
This article will help a company admin to subscribe to an API, without requiring technical knowledge of API's.
- As a company admin, open the NxtPort International portal (Link for Production and Staging). Login with your account.
- Under "My Company" you will find submenu's, allowing you to view and subscribe to API's and use-cases, called "Products" which are part of the marketplaces of the communities you subscribed to
- Under "My Communities" you will see the Products available for subscription. If you have not yet subscribed to the community that hosts the API you are looking for, please follow this tutorial first. If you don't know the community that you need to select, please create a support ticket.
- To subscribe to a Product/API, click on the "Request Subscription"button
- Each API has an owner. Depending on the owner's choice, your subscription request can be approved automatically or manually. Once it is approved you will see the time and date of acceptance and a button "Details" that will bring you to the details required to connect to the API
- In the Product Subscription screen, you will find the details to connect to the API. It provides you with the base URL, the possibility to copy your API subscription key and a button to bring you to the API swagger files ( hosted in our GitHub repository and opening a new browser window)
- Click on "Copy Subscription key" to obtain the key. Please note you are not be able to see the key at that time, but it will be in memory to copy it directly in whatever system you might be using or a Notepad.
You can always return to the Product Subscription detail section to copy your subscription key again.