Getting Started with the RukkyHub API

Getting Started with the RukkyHub API

The RukkyHub API allows developers and businesses to connect supported RukkyHub services to their own applications. Depending on the permissions enabled for your API key, available operations include retrieving SMM services, placing and checking orders, checking your balance, purchasing supported VTU services, and accessing gift card trading functions.

This guide explains how to get API access, create an API key, send your first request, and protect your integration.

Official documentation: Visit Getting Started, the Authentication Guide, and the API Reference.

What Is the RukkyHub API?

An Application Programming Interface (API) allows software applications to communicate with a service through structured requests and responses.

The RukkyHub API provides documented actions for supported services. Developers can use these actions to build integrations into websites, business applications, reseller systems, and other compatible software.

Each API key has permissions, called scopes, that determine which actions it can perform. Your integration must use actions that are enabled for your key and supported by your account.

Step 1: Activate API Access

Before making API requests, follow the access process described in the RukkyHub Developer Portal:

1. Sign in to your RukkyHub account.
2. Open the Developer Portal from your dashboard located in settings.
3. Select and purchase an available API access plan. Usually $1 to protect our API from fraudulent activities.
4. Complete any required verification or KYC steps.
5. Wait for approval if your access requires administrative approval.

API access must be active before you can use the relevant API features. Check your dashboard or contact official Support if you are unsure whether your access has been approved.

Step 2: Create an API Key

After API access is available, create a key through the Developer Portal.

1. Open Developer Portal and navigate to API Keys in settings.
2. Select the option to create or generate a new API key.
3. Enter a name that identifies the application or integration using the key.
4. Select only the scopes your application needs.
5. Enter your account PIN when requested by the portal.
6. Submit the request and securely copy the generated key.

Important: RukkyHub's authentication documentation states that the API key is shown only once when created. Store it securely immediately. If you lose it, use the documented key management process rather than expecting the original secret to be displayed again.

Step 3: Understand the API Request Format

According to the official API Reference, requests use the following configuration:

• API URL: https://developers.rukkyhub.com/api/v1
• HTTP method: POST
• Content type: application/x-www-form-urlencoded
• Response format: JSON
• Action parameter: Specifies the operation to perform.
• Authentication: Send your API key using the X-API-KEY header, as recommended by the documentation.

RukkyHub uses one main API endpoint for its documented actions. You select an operation by passing the appropriate action value and its required parameters in the request.

Step 4: Make Your First API Request

A useful first test is checking the balance associated with your API account. This example uses cURL, which is available on many development systems.

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

Replace YOUR_API_KEY with your actual API key. Run this request from a secure server or trusted development environment, not from a public webpage.

The documented successful balance response has a structure similar to this example:

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

The figures above are illustrative, not your actual account balance. Your response reflects the data returned for your account.

Step 5: Retrieve Available SMM Services

To retrieve the SMM services available through your API, use the services action.

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

The API Reference states that the service list can include service IDs, names, rates, minimum and maximum quantities, and categories.

Use the returned service IDs and limits when building your application. Do not hard-code