Versioning

The major API version is part of the URL. The current production namespace is:

https://api.requidex.com/api/open/v1

Use the documented versioned path in your integration. The version applies to the API contract; it is independent of your application's release version.

Compatible changes

Compatible additions may be introduced within v1, including new endpoints and optional response fields. Clients should ignore response fields they do not use and handle documented null values and empty collections.

Use the allowed values documented for each request parameter. If an endpoint's documented values change, review your mappings and validation before adopting them. Avoid relying on JSON property order or error-message wording.

Breaking changes

Breaking contract changes use a new major API version rather than silently replacing the v1 contract. Examples include removing a documented endpoint or response field, changing a field's type, or making an optional request field mandatory.

When adopting another major version, review its endpoint definitions, authentication and scope requirements, pagination and error handling. Test the affected read and write workflows before moving production traffic.

Track changes

Review the Changelog when creating or updating an integration. Use the published OpenAPI specification to inspect request and response schemas and check your client against the current contract.

Keep a copy of the specification used to validate each integration release so changes can be reviewed alongside your own code. Endpoint-specific notes and access restrictions remain part of the contract even when your client is generated from the specification.