Vessel Insight API's are continuously evolving to provide a better experience for our data consumers.
Here are the different generations of our APIs:
- Version 1: Primarily used for internal applications and services.
- Version 2: The current mainstream API version used by customers and partners.
- Version 3: The upcoming API version.
Our versioning and lifecycle philosophy ensures that only the latest two generations are available, meaning Version 1 will be phased out when Version 3 becomes mainstream.
APIs are always backward compatible within their generation. End-of-use notifications are issued in accordance with our subscription agreements. While we strive to maintain compatibility between generations, some adjustments may be necessary when transitioning to a newer API version.
Version 1 API
The first gen API's are mainly used for internal apps and services, but is also surfaced in a few different end user facing 1. party applications.
The 1. party applications will over time transition into using the Version 3 API's.
Version 2 API
The current mainstream API version used by customers and partners.
Main characteristics of the V2 API's are:
- API's are bundled into a consumable package with Assets, Timeseries, States and Voyage endpoints
- Subscriptions are managed from our Developer Portal which provides keys, API definitions and reports
- Provides data for what we refer to as "Owned" vessels, meaning vessels in the fleet of the entity that has subscription agreement with Kongsberg Digital
- Require certain human steps and verifications before enabling API for use in data sharing scenarios
Version 3 API
Upcoming API version with these characteristics:
- Optimized packaging and endpoints
- Subscriptions are managed from our upcoming new version of Developer Portal which will provide keys, definitions and reports
- Provides data for "Owned" and "Chartered" vessels, where "Chartered" means vessels where owner has agreed for a data sharing contract. This provides additional flexibility in that a fleet can consist of both owned and chartered vessels.
- Automated self-service process for data sharing scenarios