Persium API
The Persium API lets your backend fetch the stations, sensors, and measurement data linked to your organisation. Every endpoint is read-only and scoped to the organisation that owns your credentials.
It is a server-to-server API. Your backend authenticates with OAuth 2.0 Client Credentials against Persium's Keycloak, gets a short-lived bearer token, and uses that token on every request.
Who this is for
Backend engineers integrating Persium for the first time. Comfortable
with HTTP, JSON, and OAuth basics. Every code sample on this site is
plain curl — port it to your stack of choice.
What we will give you
Before you start, Persium provisions four values:
| Value | Description |
|---|---|
TOKEN_URL | OAuth 2.0 token endpoint at Keycloak. |
API_BASE_URL | The API base URL — typically https://api.persium.example.com/api/m2m/v1. |
CLIENT_ID | Identifier for your application. |
CLIENT_SECRET | Application secret. Treat it like a database password. |
:::warning Keep CLIENT_SECRET private
Never commit it to source control. Store it in your secrets manager
(AWS Secrets Manager, GCP Secret Manager, HashiCorp Vault, sealed
env files). If it leaks, contact Persium to rotate it.
:::
Next steps
- Walk through the Quickstart — a five-step path from token to first measurement.
- Skim the API Reference for endpoint detail.
- Read Security before going to production.