Skip to main content

OpenAPI specification

The API describes itself. Swagger UI lists every endpoint with its parameters, responses and error cases, lets you fire a call with your own key, and links the raw document — served live at /api/q/openapi, so it can never fall behind the API it belongs to.

curl -O https://app.autosignly.eu/api/q/openapi

What to do with it​

  • Generate a client in a language we do not ship yet, with OpenAPI Generator or your framework's own tooling
  • Explore the API by importing the document into Postman, Insomnia or Bruno
  • Check what changed between releases with a diff tool such as oasdiff — the same one guards our own pipeline

Versioning​

The version lives in the path (/publics/v1), not in the document. Within v1 we only add: new endpoints, new optional parameters and new response fields may appear, and your integration keeps working. Anything that would break existing callers waits for v2.

A copy of the document is committed in the SDK repository, where the tests of every official client check their field names against it — so a client that stopped matching the API fails its own build rather than yours.