Skip to main content

Admin, Observability, Versioning

Admin endpoints, metrics, versioning/deprecation, common errors, and the spec.

C
Written by Catalin Fetean
Updated over 3 weeks ago

Audience: Admins, Devs, SRE, Compliance
​Outcomes: Configure org, export data, monitor health, and evolve safely.

Admin

GET /api/admin/org POST /api/admin/org/branding # logo + invoice footer (multipart) POST /api/admin/users/invite POST /api/admin/partners/invite POST /api/admin/policies/kyc GET /api/admin/audit?from&to&actor&action POST /api/admin/exports # { type: orders|payments|releases|disputes|audit, format: csv|json }

Metrics

GET /metrics # Prometheus exposition format

Versioning & deprecation

  • REST is additive-first; breaking → /v2 or X-TradeOS-Version.

  • Webhooks add fields; breaking → new event type/endpoint.

  • SSE adds event names; keep old names until retired.

  • Maintain a dated Changelog with migration notes.

Error catalog (common)

  • UNAUTHORIZED, FORBIDDEN, VALIDATION_ERROR, NOT_FOUND, RATE_LIMITED,
    ​WEBHOOK_INVALID_SIGNATURE, PAYMENT_FAILED, ESCROW_RELEASE_FAILED, INTERNAL_ERROR.

Spec

  • OpenAPI 3.0 file: tradeos_openapi.yaml — import to Swagger UI/Redoc/Postman.

Did this answer your question?