Bappy API

Complete collection of all API endpoints for the Bappy API.

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 automatically

Authentication (OAuth 2.0)

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

Token endpoint:

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

Parameters:

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 ({identifier}) are used for resource identification
• Query parameters are used for filtering, pagination, and search
• Links accept UUID or ICCID as the {identifier} path parameter

Common Patterns:

• List: GET /resource - Returns paginated list
• Single: GET /resource/{id} - Returns single item
• Create: POST /resource - Creates new resource
• Update: PUT /resource/{id} - Updates existing resource

Response Format:

Code
{
  "success": true,
  "data": { ... },
  "meta": {
    "timestamp": "2025-01-01T12:00:00Z",
    "response_time_ms": 42
  }
}

Error Format:

Code
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found.",
    "details": null
  },
  "meta": { "timestamp": "..." }
}

Error Codes:

Pagination:

List endpoints return paginated results with meta:

Code
{
  "data": {
    "data": [...],
    "meta": {
      "current_page": 1,
      "last_page": 5,
      "per_page": 20,
      "total": 95,
      "from": 1,
      "to": 20
    }
  }
}