Reference

Versioning

What /v1 guarantees, and what may change without a new version.

The current major version is /v1, and it is part of the base URL:

https://api.civix.com.vn/v1

What may change within /v1

These are backward-compatible and will ship without a version bump. Your integration must tolerate them:

  • New endpoints
  • New optional request fields
  • New fields in a response object
  • New models, and changes to which models are available
  • New error code values

Practically: do not fail on unrecognised response fields, and treat an unfamiliar error code as a generic failure using the retryable flag rather than crashing.

What will not change within /v1

  • The meaning of an existing error code
  • Removal of a documented endpoint or response field
  • The type of an existing field
  • Authentication scheme

A genuine breaking change would ship as /v2, alongside /v1, with a migration period. We would not silently change /v1 underneath you.

Legacy /api paths

Some earlier integrations use https://api.civix.com.vn/api/.... Those continue to work and receive the same reliability behaviour as /v1.

/v1 is the canonical, documented, supported surface. New integrations should use it, and existing ones should migrate when convenient — but there is no removal date, and we will not remove /api without notice and a migration window.

Staying informed

Customer-visible changes are published in the changelog.