API Service

The Ostendo API Rest Service provides the facility for Freeway and external third-party applications to integrate with Ostendo.

Any application which can make HTTP calls can integrate with Ostendo via this service.

Even common applications like MS Excel can be integrated with Ostendo via user-written macros which talks to the Ostendo API Service.

When the Ostendo API Service is switched on or STARTED, external applications can GET information from or POST information to any table in the Ostendo database. A unique feature of the Ostendo API service is the ability to post  SQL queries to extract specific data from one or more tables.

Please note that even if all users are logged off from Ostendo, the API service remains active and running until it is STOPPED.

The data format used is primarily XML.

As a security measure, only developers/applications which are defined and authorised in the Ostendo database can have access to the API Service. It is recommended that, for enhanced security, use HTTPS instead of HTTP.

Click here to learn how to setup the API Service for Freeway. 

Click here to download the Ostendo API Service Document which explains how an external third party application can connect to an Ostendo database using the Ostendo API Service.