Use a curated external API sample for public developer docs
This development portal shows only the external developer-facing contract. Internal platform, console, carrier, routing, fraud, policy, analytics, and infrastructure APIs stay out of the public reference.
Docs mode
Reference and guide
Keep the task clear, the example nearby, and the next step obvious.
External-only index
Lead with public product flows developers actually need, then keep internal systems out of the downloadable reference.
Base URLs
Define the public environment once, then keep examples clean with {BASE_URL}.
Production
https://api.afriroute.ai
Sandbox
https://sandbox.afriroute.ai
OpenAPI-backed sample
AfriRoute External API sample
The committed OpenAPI asset is a curated public sample for development portal demos and tooling. It intentionally excludes internal platform, carrier, partner, console, routing, fraud, policy, analytics, and infrastructure endpoints.
Messaging
2 pathsExternal SMS send and message status samples for developer onboarding.
Verification
2 pathsManaged Verify helper samples that keep OTP infrastructure out of app code.
Webhooks
1 pathsExternal callback registration for delivery and verification events.
Representative external sample endpoints
Developer flows that matter first
/api/v1/sms/send
Send a single SMS message through the external developer API sample.
Request
Response
/api/v1/messages/{messageId}
Read message status from the external messaging surface.
Request
Response
afriroute.verify.start
Start a managed phone verification challenge.
Request
Response
afriroute.verify.check
Check the user-submitted code against the managed challenge.
Request
Response
/api/v1/webhooks
Register a webhook endpoint and subscribe to public delivery and usage events.
Request
Response
Generated reference
Browse the committed external API sample directly
This section is rendered from the committed sample at /openapi.json. It is suitable for public docs, demos, and Postman generation, not for publishing internal API inventory.