API versioning
Public contract
Section titled “Public contract”The current public integrator contract is OpenAPI v1, versioned at docs/api/openapi-v1.json in the source repository and copied into this static documentation build. The file is generated/reviewed separately from portal-only and internal endpoint contracts.
- Pin the SDK/API contract version used by an integration release.
- Use explicit response models and tolerate additive response fields only where your contract policy permits.
- Use stable domain error codes instead of parsing titles.
- Review scope and idempotency metadata when adding or changing operations.
- Do not assume a portal endpoint is a supported public API operation.