...
| Info |
|---|
This is an additional solution and requires a separate license. |
The API is 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
Access to the API is administered per user. In order to use the API, the user must belong to a Company defined in VIP and have the API Read, API Write, and/or API IMOS Message General Permissions enabled.
Additionally, the users user's API access will mimic the users user's existing Object and Module Permissions; for example, if the user only has Object Vessel Permissions for Vessels "A" and "B," , when requesting a list of vessels using the API, only Vessels "A" and "B" will be returned and no others.
...