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

...

  • Programmatic access to the API logs for a given account, for the purposes of monitoring compliance, uncovering misuse, and gathering data for analytics.

  • The option to embed the API Token in the authorization header of an API call. The default API syntax includes the API Token in the query parameters, while a new option embeds the token as a bearer token in an API header. This option removes the API Token from browser address bars, router logs, and other sources where the token may be exposed.

API Planned Enhancements

Note: Future enhancements are subject to change without notice.

Plans for enhancements for the API include role-based security, user-level access controls, and an API gateway to enhance API security, monitoring, and performance management.

Here is the current prioritized list for those enhancements:

...

API role-based security

...

API user-level access controls

...

Related Articles

Child pages (Children Display)

...