Developers/API Reference

REST API Reference

A complete RESTful API documented with OpenAPI 3.0. Bearer token authentication, JSON responses, cursor-based pagination.

BASE URLhttps://api.esignal.africa/v1

v1OpenAPI 3.0JSON

Authentication required

Every request requires an Authorization: Bearer {token} header. First obtain a token via POST /auth/token.

Authentication

200OKRequest succeeded

201CreatedResource created successfully

400Bad RequestMissing or invalid parameter

401UnauthorizedMissing or expired token

403ForbiddenInsufficient permissions

404Not FoundResource not found

422UnprocessableBusiness validation error

429Rate LimitedRate limit reached

500Server ErrorInternal error — contact support

Starter10 req/s10,000 req/monthBurst: 50

Pro100 req/s500,000 req/monthBurst: 500

Business500 req/sUnlimitedBurst: 2,000

Limits are returned in the X-RateLimit-Remaining and X-RateLimit-Reset headers.