Reference
API versioning & deprecation
The Century API is currently unversioned in the URL. Compatibility is maintained by policy and communicated through the changelog.
Current version
Documentation is published as v1. There is no version segment in endpoint paths and no version header to send.
Non-breaking (can ship any time)
- Adding a new endpoint or a new product.
- Adding an optional request field.
- Adding a field to a response object.
- Adding a new error code for a previously generic failure.
- Changing the human-readable text of an error message.
Parse defensively
Ignore unknown response fields rather than failing on them, and switch on error codes rather than message text.
Breaking (announced first)
- Removing or renaming an endpoint, field or error code.
- Making an optional request field required.
- Changing a field's type or units.
- Tightening validation such that previously accepted payloads fail.
Deprecation process
- The endpoint is marked deprecated in this portal with a replacement named.
- The change is recorded in the changelog under Deprecated.
- The old behaviour keeps working for a documented window before removal.
- Removal is recorded again in the changelog on the day it ships.
Watch the changelog before every release of your own integration.