API Documentation

Complete reference for the Africoders REST API v2

Getting Started

The Africoders API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

https://api.africoders.com/v1

Authentication

Include your API key in the Authorization header.

Authorization: Bearer sk_live_abc123...

Response Format

All responses follow a consistent envelope:

{ "success": true, "data": { ... }, "meta": { "page": 1, "per_page": 25, "total": 142, "request_id": "req_abc123" } }

Error Handling

Errors return appropriate HTTP status codes:

{ "success": false, "error": { "code": "invalid_api_key", "message": "The API key provided is invalid.", "status": 401 } }

200OK

400Bad Request

401Unauthorized

429Rate Limited

API Sections

Authentication

OAuth 2.0, bearer tokens, scopes

4 endpoints

Users

User accounts and profiles

4 endpoints

Courses

Course management and catalog

4 endpoints

Enrollments

Course enrollment & progress

4 endpoints

Jobs

Job postings and applications

4 endpoints

Payments

Charges, refunds, billing

4 endpoints

Webhooks

Real-time event subscriptions

4 endpoints