Versions Compared

Key

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

Home > APIs

...

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

...

  1. Do one of the following:

    • To request or clear your own API Token, open the My Profile panel.

    • As an administrator, to request or clear a user's API Token, open the User Profile tab from the Security list.

  2. In the API Token or Veslink API section, click Request New API Token.

  3. An API Token appears.

    • To request a new API Token, click Request New API Token.

    • To deactivate the current API Token, click Clear API Token.

API URL

Insert excerptVIP - Creating a Report in the Report DesignerVIP - Creating a Report in the Report DesignernopaneltrueTo get the API URL from the Report Designer to run a report through the linked API site, see https://vesonjira.atlassian.net/wiki/spaces/help/pages/64886175/VIP+-+Creating+a+Report+in+the+Report+Designer#Getting-the-API-URL-from-Report-Designer.

API Monitoring and Security

...