Note: The API requires separate licensing.

The API is a standard set of web services, implemented as a set of RESTful interfaces, that allow external systems to retrieve information and submit Veslink form XML. The available endpoints and the actions available are documented at https://api.veslink.com/Help.

The methods available via the API are mainly GET and POST (with a PATCH method available to act on IMOS Dataforms).

The API supports form XML for all standard Veslink forms.

• For Veslink with IMOSConnect: For in-port forms (for example, the Statement of Facts form), the nomination of a particular external system for a port call can occur within IMOS. These nominations are replicated from IMOS to Veslink and are accessible via the web service.

Enabling User-level Access to the API

...

• An API Token, which is generated for a Veslink user account

• An IP Whitelist Allowlist entry, specifying allowed networks or machines for API access

...