Quick Start
- Open your dashboard → Developer Portal and create an API key.
- Store the key server-side (ENV/secret manager). Never expose it in frontend JS.
- Call the API with HTTPS from your backend server.
- Use action=services to fetch valid service IDs, min/max, and rate.
- Place orders with action=add, then poll with action=status.
Base URL
https://rukkystore.com/api/v1
HTTP Method: POST | Response: JSON
Authentication
Your API key is like a password. Keep it secret.
You can send the key in the request body (key=...) or as a header (recommended).
If you revoke a key, it stops working immediately.
Security Notes
- Use HTTPS only. Do not send API keys over plain HTTP in production.
- Use scoped API keys to limit allowed actions (services/add/status/balance).
- Requests are rate-limited to reduce abuse and brute forcing.
- Order status can only be fetched for orders that belong to your account.
Actions
| Action |
Description |
Required Fields |
| services | List all services | key, action |
| add | Place a new order | key, action, service, link, quantity |
| status | Get order status | key, action, order |
| balance | Get account balance | key, action |
Order Status Values
pending
processing
completed
cancelled
refunded
partial
Status mapping: pending(0), processing(1), completed(2), cancelled(3), refunded(4), partial(5).
Examples
cURL: services
curl -X POST "https://rukkystore.com/api/v1" -H "X-API-KEY: YOUR_API_KEY" -d "action=services"
cURL: add order
curl -X POST "https://rukkystore.com/api/v1" -H "X-API-KEY: YOUR_API_KEY" -d "action=add&service=123&link=https://example.com&quantity=1000"
cURL: order status
curl -X POST "https://rukkystore.com/api/v1" -H "X-API-KEY: YOUR_API_KEY" -d "action=status&order=4488"
cURL: balance
curl -X POST "https://rukkystore.com/api/v1" -H "X-API-KEY: YOUR_API_KEY" -d "action=balance"
PHP Example File
https://rukkystore.com/assets/php_api_example.txt
Common Errors
- Invalid api key: key is wrong or revoked.
- This API key is not allowed for this action: your key scope does not include the requested action.
- Please follow the limit: quantity outside min/max range.
- Insufficient balance: not enough funds or minimum balance would be violated.