# REST API for IHM

# Access

We have created a REST server at https://api.zeeborn.info that provides the requested data in JSON format.

We have two endpoints

/sitelist for receiving the list of currently active vessels
/poinfo for receiving all PO items for a selected vessel and year

Each request must include an access token for authorization. The access token is

[available via support@zeeborn.net]

# How to retrieve data?

Via the endpoint /sitelist you get access to all currently active sites. The endpoint delivers details: ID, IMONO and SiteName. The ID will be used later on for requesting a vessels PO info.

Endpoint /poinfo expects as additional parameters


siteid	ID of vessel
year	year of all PO items to be requested

# Examples

Receiving site list:

https://api.zeeborn.info/sitelist?token=[token]

Receiving PO items for vessel for 2017:

https://api.zeeborn.info/poinfo?token=[token]&siteid=[id]&year=2017

The response time can be up to 10 or more seconds for the first request – depending on the amount of data requested.

The REST server should be online most of the time, but may be offline for a few minutes every now and then while updating the server software.