Home > APIs
...
| Note |
|---|
UN Code Changes May Affect Integrations
Starting in September, 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
...
| Expand |
|---|
| title | Related 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:
|
|