New API documentation

We are happy to present a new API documentation. It is now available at https://doc.adocean-global.com/. 

Please note: in about a month the old documentation will be disabled (only the new one will work). It is also worth knowing that the link to the documentation on the website https://adocean-global.com/en/product/api/ will soon change to redirect to the new documentation.

Changes which stand out the most are:

Refreshed view

We present renewed and more transparent and user-friendly view. Now using the AO API documentation is much more pleasant and eye-friendly.

Commands and parameters search

From now on searching for commands is much easier. It is enough to enter in the search engine the matched pattern of the function name itself or the names of the parameters appearing in it:

Built-in API form

New documentation has the functionality of both the old documentation and the API form available at https://api.adocean.pl. In other words it is possible to send an API request from documentation level:

Please note: API form available at https://api.adocean.pl will be disabled in a month (its functionalities will be taken over by the new documentation).

Also you can spy the examples of response, as well as the schema of the objects:

Ability to copy http request with curl

After sending the request, the request can be viewed with the curl command:

Ability to change a response format

What's more there is possibility to change response format: XML or JSON. You can do it in API Servers (JSPN/XML) tab:

Ability to save API Key

To make it easier for you to use the API documentation, you can save your session in the Authentication tab. After entering the newly opened session, the session ID will be entered automatically for each function:

It's worth noting that the link to the api itself will not change - only the documentation changes. 

api