Developers
Versioning
How the public API is versioned and how changes are rolled out.
The public API is versioned in the URL path:
https://api.ardent.africa/public/v1/...Stability promise
Within a version (v1), we treat the response shapes documented in the
endpoint reference as stable. We may:
- add new endpoints,
- add new fields to existing responses.
We will not, within v1:
- remove or rename existing fields,
- change the type of an existing field,
- remove an endpoint.
Write your integration to ignore unknown fields, so additive changes never break you.
New versions
A breaking change ships under a new path (/public/v2/...). The previous version
keeps working during a deprecation window announced in the
changelog.
Pin to v1
Always call the explicit version path. Do not rely on an unversioned URL.
Last updated: 18 June 2026