Introduction¶

Base URL¶

The Stativate API base URL is

https://api.stativate.de/v1/

Basic concepts¶

The Stativate API is an HTTP API built with REST in mind:

• HTTPS API
• JSON format for request and response payloads
• URL structure based on entity relations
• HTTP Methods to determine operation type
• HTTP Status Codes used in responses

Payload format¶

The Stativate API accepts only JSON Payloads.

Content Type¶

The API accepts only JSON payloads. The content type is application/json.

Security and privacy¶

The Stativate API is only available via HTTPS with encryption. There is no plain HTTP API for security and privacy reasons.

Functional scope¶

At the moment, Stativate offers a public API for specific functionalities. Those functinoalities are mainly data-oriented. All operations not documented here are not part of the public Stativate API.