API
How to explore endpoints, authenticate, paginate, and handle webhooks safely.
OpenAPI
Use the in-app viewer for exact schemas and parameters:
- [OpenAPI viewer](/openapi)
Auth & headers
Authorization: Bearer <YOUR_TOKEN>
Content-Type: application/jsonResponse & errors
Common envelope:
{
"code": 0,
"msg": "OK",
"data": {}
}code === 0usually indicates success.- Some endpoints may return a
detailfield (validation-style errors).
Pagination & filtering
Follow OpenAPI per-endpoint. Common patterns:
?limit=20&offset=0?page=1&page_size=20
Filtering is typically query params (example): ?environment=dev
Webhooks
Webhook rules
- Verify signatures
- Idempotency by event id
- Expect duplicates (at-least-once)
Rate limits & retries
- For 429, back off with exponential delays (add jitter).
- For 5xx, retry carefully and log envelope fields (
code/msg/detail).