What is the Ostara API?

API (Application Program Interface) allows the interaction of the Ostara System with another software application. It is the communication method between Ostara and other sources of data.

Introduction

The Ostara API was created to provide Contractors who currently use (or have recently been requested to use) Ostara for their Clients.

The benefits to the Contractor are the elimination of double entry of data into both the Ostara System and their own in-house system. This is not a substitution for the use of the Ostara Mobile Application, but instead it compliments the use of the Ostara Mobile Application by sending collected data to Contractor systems following the use of the Ostara Mobile Application.

API Documentation

The API documentation is version controlled, and is held on the Portal for the Client you are providing a service to. The URL for this will be of the following format:

https://[client]-ostara.ostarasystems.net/documentation/

Where [client] should be replaced with the client name in the URL you would normally use to access the Ostara web portal. If you are a new Contractor who has yet to receive login detail to the portal, please contact your Client contact for Ostara to request this detail.

The documentation here should give your technical team all the information they need to connect to the Ostara API.

It should be noted that Ostara does not connect into Contractor APIs – the Contractor will need to connect to Ostara using the details provided in the documentation link.

Terms and Conditions

Use of the Ostara API will be subject to agreement to the Ostara API Terms and Conditions, located via the documentation link provided above.

Use of the Ostara API is acknowledgement of acceptance of these terms.