Detailed Help Documentation

 

Hivedome have adopted a commonly used Web Services tool known as APIARY (https://apiary.io/), an online API developer’s resource that allows code snippets in multiple languages, data (structure), object definitions, mock data examples and so on. It provides a pseudocode that allows the API endpoints to be described to the extent that they can be dynamically mocked up quickly in any language. Being online this provides clients with a one-stop shop for documentation and investigation without writing a line of code. Moving forward it allows anyone to write guidance notes for an audience that will consist of both API developers and business analysts alike. It provides public facing access from any middleware environment as well as standard discovery tools commonly used by developers such as POSTMAN.

 

Links to ITAS API help portals (V1 and V2) and Apiary are available from ITAS servers and can be found in three ways:

1. http://{servername}:4720 this link will only be available in each client's local network.

2. Via a Menu link in Trader Desktop (see below)

3. Via the Help Menu in Trader Desktop (see below)

Or you can download the API Developers Guide V2 pdf here

 

 

All of these link to a variety of online help resources including V1 Web Services help including the ITAS Event Engine, V2 Apiary links covering all the example endpoints for V2, Developer Guides for V1 services and Developer Guide for V2 services.


Was this helpful?
Thanks for your feedback