To access the Vessel Insight APIs, you’ll need the following:
- Consumers need a direct or indirect business relationship with Kongsberg Digital.
- Subscription key: To be used in the headers of all API calls. Created via self service in the developer portal.
- Credentials: To be used when getting an access token. Will be sent from KDI upon setup.
Details on authorization and authentication in the APIs can be found in API Authorization and Authentication.
Subscription
In order to access the API, you will need to request a subscription.
- Create a user in the developer portal: https://developer.kognif.ai/signup
- Log into the portal
- Go to Data Services
- Click on “Vessel Insight V2 API”
- Enter a meaningful name
- Click Subscribe
Next, your API subscription key will show on your User Profile page.
Use this in the headers is required when calling the API (details in the getting started guide)
Credentials
In addition to the subscription key from the Developer Portal above , you need the following identifiers to be able to access the customer data through the Vessel Insight API:
- tenant_id = Customer specific.
- client_id = Data user specific on the above customer tenant.
- client_secret = Data user specific on the above customer tenant.
- resource_id = Points to an environment in Kongsberg Digital.
You will get these the following way:
- Client Id, Tenant ID and Resource ID: KDI will send an encrypted email with these.
- Client Secret: KDI will send a separate encrypted email for this
- Resource_id: You will receive this in the Welcome email after subscription is activated
The post request for getting a token should look something like this:
curl --location 'https://login.microsoftonline.com/<tenant_id>/oauth2/token'
\--header 'Content-Type: application/x-www-form-urlencoded'
\--header 'Cookie: fpc=AoOV5s7BVgBIhQliAom3ZACiE3uqAQAAACc8qN4OAAAA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd'
\--data-urlencode 'grant_type=client_credentials'
\--data-urlencode 'client_secret=<client_secret>'
\--data-urlencode 'client_id=<client_id>'
\--data-urlencode 'resource=<resource_id>'