Skip to content

Data API

Click on the following link to open the Saveris Data API documentation.

The Data API provides RESTful calls to an interface to retrieve data about HCCP or monitoring information. It is designed for developers who want to interact with the data programmatically.

The API is built using the OpenAPI 3.0.0 specification and follows the REST architectural style. It uses JSON for data exchange and supports standard HTTP response codes for successful and unsuccessful requests.

Base URL

The URL for this API is: https://data-api.REGION.ENV.savr.saveris.net/v1

The REGION and ENV in the URL should be replaced with the specific region and environment you are using. There are two environments available: "i" for integration and testing, and "p" for production. Furthermore we have three regions: "eu" for europe, "am" for america and "ap" for the apac region.

Security

The Data API uses Bearer token authentication. You should acquire a token and use it to authenticate your requests.

To get a token you need to authenticate using a /token endpoint of the Data API. Here you will just need to send your username and password in the body and you will receive the idToken.

API Endpoints

The API has 2 major types of endpoints: synchronous and asynchronous.

Synchronous Endpoints

The synchronous endpoints are the ones that return the data directly in the response. Be aware, that these endpoint are limited in the amount of data they can return. If you need to retrieve a large amount of data, you should use the asynchronous endpoints. In the following the request flow is described in more detail.

Synchronous Request Flow

  1. Authenticate by using the /token endpoint.
  2. Send a GET request to /endpoint and get a json result back.

Asynchronous Endpoints

In contrast to the synchronous endpoints the asynchronous endpoints do not return results directly. Instead, they trigger a request that creates files with the data. In a second request, the list of urls to the files is returned. The urls are pointing to the files that contain the data. This mechanism allows us to provide large amounts of data. In the following the request flow is described in more detail.

Asynchronous Request Flow

  1. Authenticate by using the /token endpoint.
  2. Send a POST request to /endpoint and get a UUID of the request back.
  3. Check the request status and results using the /endpoint/request_uuid endpoint.
  4. When the request status is Completed, a list of one or more data urls is returned.
  5. Download the dataset from the data URLs.

CORS support

The API supports CORS (Cross-Origin Resource Sharing) to allow cross-domain communication. To enable CORS, the server returns the appropriate headers in the response.