Some ship owning companies may already have a structured internal system to maintain their ship information but still want to use the semi-automatic options in Ankeri to answer questionnaires from potential charterers. For those companies, the Ankeri profiles for all their ships can be automatically maintained by connecting their internal systems with Ankeri using the Ankeri API.
How to login to the Ankeri API?
To use the Ankeri API you will need to authenticate. Authentication is done with a JSON Web Token (JWT) that needs to be included in the header of each request (except for login) to the API. The login resource provides the token and expiry date (24 hours valid) as request response, with the Ankeri email and password as payload.
The following screenshots demonstrate how this based Ankeri API Swagger documentation.
How to get an overview of the questionnaire fields?
To get an overview of questionnaire fields, make a get request to the properties resource. Please remember to include the token in the request header.
The request response includes the total number of the fields and then more details for each field, such as field title, description, unit and id.
How to update a questionnaire field?
To update a questionnaire field, make a put request to the ships/{imoNr}/properties/{propertyId} resource with propertyValue as payload. The property id is obtained from the properties resource, as described above. After the put request, the property value has been updated in Ankeri. To confirm this, the request response includes the ship's IMO number and an overview of the updated property. For example, the property title and value.
Request Ankeri to integrate your data sources
Ankeri API is intended for data analysts and IT experts. Ankeri can integrate your internal IT systems and make them sources of data in Ankeri. This way, you can update your ship information in Ankeri with a click of a button. Please contact us at ankeri@ankeri.is if you wish to more information on this option.
About Ankeri
Ankeri is an online service developed by Ankeri Solutions. We aim at providing easy to use and simple means for ship owners and charterers to share ship specific information. To learn more visit our website ankeri.net or feel free to reach out to us at ankeri@ankeri.is