Skip to content

Getting Started

To use the API in simulation:

  1. Open Swagger at https://localhost/rest/docs.
  2. Call GET /api/v2/auth/ with X-API-Key.
  3. Copy the token value from the response.
  4. Click Authorize in Swagger and enter Bearer <token>.
  5. Call protected endpoints.

For long-running clients, refresh the token with GET /api/v2/auth/refresh/ before the JWT exp time. The refreshed token is returned in the Authorization response header.

The API supports:

  • REST API for stateless operations.
  • WebSocket API for real-time streaming.

Current versions:

  • /api/v2: explicit route-based API (recommended).
  • /api/v1: legacy generic command API kept for migration.