Telkor API

Complete API reference for the Telkor API — coverage and plan management, SIM inventory, link lifecycle, bulk operations, and organisation account data.

Quick Start

1. Get your client_id and client_secret from OmaxTelecom Console
2. Run Auth → Get Access Token to obtain a Bearer token
3. All other endpoints use the access_token in the Authorization header

Authentication (OAuth 2.0)

This API uses the OAuth 2.0 Client Credentials grant type (RFC 6749 §4.4).

Token endpoint:

Code
POST https://api.omaxtelecom.com/auth/token

The token endpoint returns a Bearer access_token with a limited lifetime (expires_in seconds). When the token expires, request a new one — there are no refresh tokens in this flow.

API Design

The API follows RESTful conventions:

• Path parameters identify resources (coverage_id, sim_id, plan_id, link_id, etc.)
• Query parameters are used for filtering, pagination, and search
• All data is scoped to your organisation (tenant)
• Bulk operations return a task id — poll GET /tasks/{task_id} for progress

Common Patterns

• List: GET /resource — returns a paginated list
• Single: GET /resource/{id} — returns a single item
• Create: POST /resource — creates a new resource
• Update: PATCH /resource/{id} — partial update
• Delete: DELETE /resource/{id} — soft-delete (returns 204)
• Bulk: POST /resource/bulk-* — async bulk job (returns task)

Pagination

List endpoints return paginated results:

Code
{
  "items": [...],
  "total": 42,
  "page": 1,
  "page_size": 25,
  "total_pages": 2
}

Error Format

Code
{
  "message": "Entity not found: id=...",
  "code": "entity_not_found",
  "details": { ... }
}

Error Codes