OriginsNext provides a suite of public APIs for system-to-system integration. These APIs follow a versioning strategy to ensure stable integrations while continuously delivering new features and improvements.
Why API versioning matters
API versioning matters because it:
Lets clients adopt new features at their own pace.
Gives predictable upgrade timelines when a change may break existing integrations.
Key terms
These are the key API versioning terms and what they mean:
Term | Definition |
Current version | Actively supported version with the latest features and improvements |
Deprecated | Still supported but will be retired after a defined period |
Breaking change | Any change to the API contract (path, request, response, or behaviour) that may affect current integrations |
Important: a new API version is only introduced when there is a breaking change.
Support for deprecated versions
When a new version is released, the previous version becomes deprecated, and support works as follows:
The previous version becomes deprecated.
Deprecated versions remain supported for at least 3 months.
Example: if version v1 was released on 1 Jan 2024 and v2 was released on 1 Mar 2024, clients using v1 are supported until at least 2 Jun 2024.
How to upgrade to the latest version
OriginsNext uses path-based versioning (for example, /v3/your-endpoint). To upgrade to the latest version:
Open the API documentation specific to the endpoint you are using (for example, Movements Production API).
Check the version number at the top-right corner of the documentation.
If your current version is outdated, locate the section detailing breaking changes.
Review the changes introduced in newer versions to understand what may need updating in your integration logic.
When ready, update your integration URL to the new version (for example, change from /v2/ to /v3/).
Test the integration in the Sandbox environment before moving to production. You can find Sandbox URLs in the API documentation.
Note: each API documentation page is versioned. The breaking changes listed are relative to the previous version.