Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Home > APIs

...

Info

This is an additional solution and requires a separate license.

Note

UN Code Changes May Affect Integrations
Starting in September 2021, we will be standardizing UN codes by removing 2 digit codes, removing duplicates, and adding official UN codes to the database. This could affect integrations.

Learn more

...

Excerpt

The APIs module provides a standard set of web services, implemented as a set of RESTful interfaces, that allow external systems to retrieve information and submit Voyage Reporting 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 Voyage Reporting forms.

  • 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 VIP. These nominations are replicated from VIP to Voyage Reporting and are accessible via the web service.

Enabling User-level Access to the API

...