Endpoints of the API are prefixed with a corresponding version number.
Benefits of Versioning
Isolated Implementations
Versioning isolates different API implementations, preventing conflicts.
Stable Integrations
Versioning guarantees that major API updates do not disrupt existing integrations.
API Change Types
Within a major API version, only non-breaking changes are introduced.
Non-Breaking Changes (Backward Compatible)
These changes do not require integration updates and are released without prior notification. Examples:
- Adding new API endpoints.
- Adding optional fields to requests or headers.
- Adding fields to responses or headers.
- Data updates (countries, operators, products, services):
- Adding new entities.
- Modifying field values (names, prices, status).
- Adding fields to callback requests.
Key Action: Validate your integration's ability to handle non-breaking changes before production.
Breaking Changes (Major Updates)
These require integration modifications and occur with major API version updates. Examples:
- Removing or renaming API endpoints.
- Adding required fields to requests or headers.
- Removing or renaming fields in requests, responses, or callbacks.
Key Action: Test new API versions in the sandbox before deploying to production.