Preview: the public API is not live yet. The guides are drafts shared before the first endpoints open and may change.
Limits and versioning
Draft.
Rate limits
Request limits are applied per tenant (company). Clients bound to the same company consume the limit together.
General advice: when throttled, do not retry immediately; increase the wait exponentially.
Versioning
- The version is part of the path:
/api/v1. - Within
v1only additive changes occur (new endpoint, new optional field, new response field). Your client must ignore response fields it does not know. - Any change that alters the meaning, format or requiredness of an existing field is breaking and is made only in a new major version (
/api/v2). - Webhook event schemas are versioned too: if a schema changes, a new version of the event is published (see Webhooks and events).
- File templates (import/export) carry
sablon_koduandsablon_surumu; a breaking change is a new template version.
Deprecation policy
When a new major version is released, the previous major version is supported for at least 12 months.
Deprecation notices appear in the changelog.
The shutdown date of a deprecated version is stated in the notice.
Changelog
All changes are kept in CHANGELOG.md.