API Overview

Base URL

$API_BASE_URL/v1

The base URL is configured by the API product owner. Check the portal homepage for the exact URL for this integration.

Versioning

The API is versioned via URL path prefix (e.g. /v1/). Breaking changes are introduced under new major versions.

Error format

All errors follow the RFC 7807 Problem Details format:

{
  "type": "https://errors.example.com/rate-limit-exceeded",
  "title": "Rate Limit Exceeded",
  "status": 429,
  "detail": "You have exceeded 1000 requests per minute.",
  "retryAfter": 42
}