Quickstart
Integrate the platform in a way that scales as additional domains are added.
Integration Strategy
Start with one domain, but structure your client as a platform client.
Recommended shape
- One base URL configuration
- Shared auth header strategy
- Shared error handling and retry policy
- Domain-specific modules (
countries,demographics,economy,geography)
1. Confirm Platform Health
curl "https://api.africa-api.com/health"Expected response:
{ "status": "ok" }2. Call a Domain Endpoint
curl "https://api.africa-api.com/v1/countries"3. Add Filtering and Sorting
curl "https://api.africa-api.com/v1/countries?region=west&sort=-area"4. Fetch One Resource by Identifier
curl "https://api.africa-api.com/v1/countries/ng"5. Use Caching Correctly
Country list responses include ETag and Cache-Control headers.
curl -i "https://api.africa-api.com/v1/countries" \
-H 'If-None-Match: W/"<etag-value>"'Expect 304 Not Modified when data is unchanged.