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

...

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

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

    • By default the Allowlist is unenabled, allowing accessing from any IP address. Please submit a support request to restrict access to certain IP addresses.

Once a user's API Token is generated, it will not expire; however, each user has access to their own API Token in the same way and can refresh or clear the token as often as desired. The Administrator can revoke API access for a user by modifying the user's Voyage Reporting Permissions.

...