Skip to content

API Reference

The Consystence platform exposes REST APIs for authentication, organisation management, site configuration, and device interaction.

Base URLs

Service Environment Base URL
Auth Production https://account.consystence.com
Auth Development https://account.consystence.dev
Platform API Production https://api.consystence.com
Platform API Development https://api.consystence.dev

Authentication

All API requests (except login, register, and OIDC discovery) require a Bearer JWT token in the Authorization header:

Authorization: Bearer eyJhbGciOiJSUzI1NiIs...

Tokens are obtained from the Authentication API and scoped to an organisation. See Platform > Authentication for details on claims and multi-org support.

Response format

All endpoints return JSON. Successful responses use standard HTTP status codes:

Code Meaning
200 OK Request succeeded
201 Created Resource created
204 No Content Request succeeded, no body
400 Bad Request Validation error
401 Unauthorized Missing or invalid token
403 Forbidden Insufficient permissions
404 Not Found Resource does not exist
409 Conflict Duplicate or conflicting state
429 Too Many Requests Rate limit exceeded

Error responses include a structured body:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Organisation name is required",
    "details": [
      { "field": "name", "message": "Must not be empty" }
    ]
  }
}

In this section

  • Authentication API — login, registration, token refresh, OIDC discovery, MFA.
  • Organisation API — create, list, update organisations and manage members.
  • Site API — create and manage sites within an organisation.
  • Device API — read tags, write tags, execute commands, and query alarms.