Note: The API requires separate licensing. You must have the Use Veslink API General Permission enabled.

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

Access to the API is administered per user. In order to use the API, the user must belong to a Company defined in Veslink and have the "Use Veslink API" permission enabled.

If a user has API access, there is no additional security assigned to endpoints. The exception to this policy is for reports. The Administrator can assign or revoke access to reports on a per-user basis. On top of the report access privileges, the creator of a report can make the report private or public, which adds another layer of access security on reports.

...