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

...

API

...

API Monitoring and Security

Veson Nautical has added monitoring and security enhancements to the API, namely:

...

  1. API role-based security

  2. API user-level access controls

  3. API Gateway

Related Articles

Child pages (Children Display)

Expand
titleRelated Configuration Flags

Name/Flag

Description

API Reports Raw Column Names
CFGAPIReportsRawColumnNames

If enabled, getting reports via the API will assign column names based on table.column format.

Enable JSON Path Query
CFGEnableJsonPathQuery

When enabled, Report Designer reports will have the Optimize query for document export option available. This makes exporting to XML via datashed and the API faster for certain reports. Requires SQL Server 2016 or newer.

Email Web Hook
CFGEmailWebHook

Provides the ability to send the eml URL generated when triggering an email from VIP to a specific endpoint. Place the {emlUrl} placeholder where you want it to appear in the endpoint you are configuring.

The outgoing email includes:

  • To, CC, and BCC email addresses

  • Subject heading

  • The email message, either:

    • Embedded in the HTML body

    • Attached as a PDF