API Versioning
AfriRoute supports explicit API version selection and a lifecycle model (stable → deprecated → sunset). This page documents how to select a version and what guarantees apply.
Current versions
Selecting a version
Header-based (recommended)
curl BASE_URL/api/v1/channels/sms/send \ -H "X-API-Key: $AFRIROUTE_KEY" \ -H "X-AfriRoute-Version: 2026-06-01"
curl BASE_URL/api/v1/channels/sms/otp \ -H "X-API-Key: $AFRIROUTE_KEY" \ -H "X-AfriRoute-Version: 2026-06-01"
URL-based
curl BASE_URL/v2/messages \ -H "X-API-Key: $AFRIROUTE_KEY"
Response headers
HTTP/1.1 200 OK X-API-Version: v2 X-API-Version-Status: beta
Breaking change policy
- Breaking changes are introduced in new versions only.
- Deprecated versions remain available for a transition window (timeline published with deprecation).
- Migration guides accompany breaking changes where applicable.