-
Getting started
The Vessel Insight API lets you connect to vessel data. This guide demonstrates how to make your first API calls by fetching datapoints for a path. For more info on datapoints and paths, please check out the core concepts page Overall dataflow. There is also a Postman collection for testing the APIs available.…
-
Accessing the API
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…
-
Get asset model info
As mentioned in the concept section, the data is structured in an asset model, where sensors are mapped to system paths. There are two main ways to identify what data is available from a vessel: Getting a list from KDI containing the mapped paths. Fetching a filtered list of paths from the POST FindNodes endpoint. This…
-
Get data
This section describes methods and endpoints for fetching data from the VI APIs. The guide assumes you have a list of paths ready, as the paths are used as parameters to select which data to return in the API calls as explained in Get asset model info. Get data for multiple paths in one request A recommended practice is to…
-
Get voyage data
Using Voyage data typically involves querying these endpoints in the Voyage API: Voyage History Location history The following gives an introduction to using the API. To read more on voyage tracking in Vessel Insight, please look at Voyage Data concept article. Voyage history A typical usage scenario for voyage data…
-
Get connectivity and data status
The data flow is prone to various fault scenarios, and this section covers how to check and work around some basic scenarios. As described in the overall dataflow section, a key point with the solution is that Vessel Insight sends raw data as-is from the data sources onboard. In a scenario where no new data is available in…
-
Setting up data pipelines
The previous sections covered methods to identify paths and fetching data through the API. In this section we'll put the capabilities together and explore best practices to set up pipelines and workflows. The API is designed and aimed at covering the following use cases: Fetch close-to-realtime data from the vessel and…
-
Previews
In this section we highlight preview and upcoming features in the Vessel Insight API. Time Weighted Average aggregate In cases where we are interested in accumulating values from e.g. a flow rate sensor or a power sensor and the sampling frequency is irregular, the standard "Average" aggregate is not sufficient. We are…
-
Postman collection
Remember to Add subscription key in the headers of all VI API calls, Add tenant ID in the Microsoft Login URL and credentials as body.
-
FAQ / Support
This section covers typical question and issues, and how to solve them. Timestamps out of synch If timestamps are out of sync from a source system, there are 2 options perform to overcome, which can be agreed with our support team: Correct the clock to show UTC in source system. Override timestamp on edge computer with a…