Getting Started

Integrate RukkyHub's API into your application in under 5 minutes. The API uses a single POST endpoint with action parameter for all operations.

1. Purchase API Access

Go to your dashboard → Developer Portal → select an API access plan and purchase it. If API access is not active, you must buy a plan (KYC may be required) and wait for admin approval.

2. Create an API Key

Navigate to Developer Portal → API Keys and click Generate New Key. Give it a label, select the permissions/scopes (services, add, status, balance, vtu actions, etc.), and enter your PIN. Copy the key immediately — it won't be shown again.

3. Base URL

All API requests should be made via POST to:

https://developers.rukkyhub.com/api/v1

HTTP Method: POST | Content-Type: application/x-www-form-urlencoded | Response: JSON

4. Make Your First Request

Test your API key by fetching your balance:

curl -X POST https://developers.rukkyhub.com/api/v1 \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d "action=balance"

Successful response:

{
  "balance": 2500.00,
  "currency": "NGN"
}

5. List Services

curl -X POST https://developers.rukkyhub.com/api/v1 \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d "action=services"

6. Place Your First Order

curl -X POST https://developers.rukkyhub.com/api/v1 \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d "action=add&service=123&link=https://example.com&quantity=1000"

Quick Integration Flow