Key delivery API
Deliver RingX license keys from your own store automatically. When your customer pays, your server orders a key, your balance is charged your reseller price, and you send the key to the customer. No manual key creation.
Quick start
- Create an API key. Log in to your RingX dashboard → API Keys → Create API Key, and tick
keys:readandkeys:write. Copy it right away; it is shown only once. - Top up your balance. Every order is paid from your reseller balance at your reseller prices.
- List your products with
GET /productsto get eachproductIdand plantype. - Order a key with
POST /keyswhen your customer pays, using your own order id asreference. - Send the key to your customer. The plan time starts when they first activate it in the RingX launcher.
Authentication
Base URL: https://ringx.cc/api/v1/reseller
Send your API key on every request, in either header:
Authorization: Bearer bl_live_YOUR_KEY
# or
X-API-Key: bl_live_YOUR_KEYRequests and responses are JSON. Keep the key on your server only: never put it in a web page, a browser script, a mobile app or a public repository. Anyone with the key can spend your balance. If it leaks, revoke it in the dashboard and create a new one.
Rate limit: 60 requests per minute per API key (ask us if you need more). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Above the limit you get 429.
Endpoints
| Request | Permission | What it does |
|---|---|---|
GET /products | keys:read | Products you can sell and your reseller price for each plan. |
GET /balance | keys:read | Your current balance in EUR. |
POST /keys | keys:write | Order keys. Your balance is charged your reseller price. |
GET /orders/{reference} | keys:read | An order you already placed, with its keys. |
GET /keys/{key} | keys:read | Status of one of your keys. |
POST /keys/refund | keys:write | Refund unused keys back to your balance. |
GET /products
Products on your account that are on sale now, with your price per plan. Only plans with a reseller price are listed.
curl https://ringx.cc/api/v1/reseller/products \
-H "Authorization: Bearer bl_live_YOUR_KEY"{
"products": [
{
"productId": 3,
"name": "FC27 Premium",
"slug": "fc27-premium",
"status": "UNDETECTED",
"currency": "EUR",
"plans": [
{ "type": "daily", "price": 8 },
{ "type": "weekly", "price": 24 },
{ "type": "monthly", "price": 35 }
]
}
]
}Plan type values: hourly, daily, threedays, weekly, monthly, threemonths, lifetime.
GET /balance
curl https://ringx.cc/api/v1/reseller/balance -H "Authorization: Bearer bl_live_YOUR_KEY"{ "username": "yourshop", "balance": 492, "currency": "EUR" }Order keys — POST /keys
curl -X POST https://ringx.cc/api/v1/reseller/keys \
-H "Authorization: Bearer bl_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"productId": 3, "type": "daily", "quantity": 1, "reference": "order-10045"}'| Field | Required | Description |
|---|---|---|
productId | yes | From GET /products. |
type | yes | A plan listed for that product, e.g. daily, monthly. |
quantity | no | 1 to 100. Default 1. |
reference | yes | Your own unique order id. 1–100 characters: letters, digits and . _ : # -. |
{
"reference": "order-10045",
"productId": 3,
"type": "daily",
"quantity": 1,
"pricePerKey": 8,
"totalCost": 8,
"currency": "EUR",
"balanceAfter": 492,
"keys": ["fc27premium-1a2b3c4d-5e6f7a8b-9c0d1e2f-3a4b5c6d"],
"refundedKeys": [],
"createdAt": "2026-11-18T01:04:42.502Z",
"replay": false
}Safe retries: the reference makes every order idempotent. Sending the same reference again returns the same keys with "replay": true and charges nothing. A new order answers 201, a replay 200. If a request times out, just send it again with the same reference.
Look an order up later with GET /orders/{reference} — same response shape:
curl https://ringx.cc/api/v1/reseller/orders/order-10045 -H "Authorization: Bearer bl_live_YOUR_KEY"Refunds — POST /keys/refund
Give back keys you did not use: what you paid for each one returns to your balance and the key is disabled permanently.
curl -X POST https://ringx.cc/api/v1/reseller/keys/refund \
-H "Authorization: Bearer bl_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"keys": ["fc27premium-1a2b3c4d-5e6f7a8b-9c0d1e2f-3a4b5c6d"]}'{
"refunded": [{ "key": "fc27premium-1a2b3c4d-5e6f7a8b-9c0d1e2f-3a4b5c6d", "amount": 8, "reference": "order-10045" }],
"alreadyRefunded": [],
"totalRefunded": 8,
"currency": "EUR",
"balanceAfter": 500
}- A key is refundable while nobody has activated it. Once a customer signs in with it, it cannot be refunded.
- Keys you paid for from your balance can be refunded, whether you ordered them through the API or created them in the dashboard. Disabling one of your own unused paid keys in the dashboard refunds it automatically too.
- Send 1 to 100 keys. All or nothing: if one key cannot be refunded, nothing is refunded and
details.keysgives the reason for each. - A refunded key can never be re-enabled. Keys refunded earlier are listed in
alreadyRefundedand never credited twice, so retrying is safe.
{
"error": "NOT_REFUNDABLE",
"message": "Some keys cannot be refunded. Nothing was refunded.",
"details": { "keys": [{ "key": "fc27premium-…", "reason": "KEY_USED" }] }
}Refusal reasons: KEY_USED (activated), KEY_DISABLED (already disabled), KEY_NOT_FOUND (not on your account), NOT_AN_API_KEY (not paid from your balance, e.g. a free key).
Key status — GET /keys/{key}
curl https://ringx.cc/api/v1/reseller/keys/fc27premium-1a2b3c4d-5e6f7a8b-9c0d1e2f-3a4b5c6d \
-H "Authorization: Bearer bl_live_YOUR_KEY"{
"key": "fc27premium-1a2b3c4d-5e6f7a8b-9c0d1e2f-3a4b5c6d",
"productId": 3,
"type": "daily",
"status": "activated",
"activatedAt": "2026-11-18T10:12:00.000Z",
"expiresAt": "2026-11-19T10:12:00.000Z",
"hwidBound": true,
"refunded": false
}| status | Meaning |
|---|---|
unused | Created, never activated. The plan time has not started. Refundable. |
activated | Bound to the customer’s PC. The plan time is running. |
expired | The plan time is over. |
disabled | Turned off (refunded, banned or disabled by you or RingX). |
expiresAt is null until the key is activated. hwidBound is true once the key is bound to a PC.
Errors
Errors are JSON: {"error": "CODE", "message": "…", "details": {…}}. When a request fails, nothing is charged and nothing changes.
| HTTP | Codes | What to do |
|---|---|---|
400 | INVALID_PRODUCT, INVALID_TYPE, INVALID_QUANTITY, INVALID_REFERENCE, INVALID_KEY(S), NO_RESELLER_PRICE, TYPE_UNAVAILABLE | Fix the request. Nothing was charged. |
401 | API key required / invalid | Missing, unknown or revoked API key. |
402 | INSUFFICIENT_BALANCE | Top up your balance. details.balance and details.required tell you by how much. Nothing was charged. |
403 | NOT_A_RESELLER, missing permission | The key belongs to a non-reseller account or lacks keys:read / keys:write. |
404 | PRODUCT_NOT_FOUND, ORDER_NOT_FOUND, KEY_NOT_FOUND | Nothing with that id on your account. |
409 | SALE_NOT_ELIGIBLE, SEPARATE_STOREFRONT, NOT_REFUNDABLE | Product not on sale right now, or a refund was refused (details.keys says why). Nothing changed. |
429 | Rate limit | Too many requests. Wait for the time in Retry-After / X-RateLimit-Reset. |
500 | INTERNAL_ERROR | Retry with the same reference; you will never be charged twice. |
Code examples
Node.js
// Node.js 18+ (server side only)
const RINGX = 'https://ringx.cc/api/v1/reseller';
const headers = { Authorization: `Bearer ${process.env.RINGX_API_KEY}`, 'Content-Type': 'application/json' };
export async function deliverKey(order) {
const res = await fetch(`${RINGX}/keys`, {
method: 'POST',
headers,
body: JSON.stringify({ productId: 3, type: 'monthly', quantity: 1, reference: `shop-${order.id}` }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error}: ${data.message}`);
return data.keys; // send these to your customer
}PHP
<?php
// PHP 7.4+ with cURL (server side only)
function ringx_order_key(string $orderId): array {
$ch = curl_init('https://ringx.cc/api/v1/reseller/keys');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('RINGX_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'productId' => 3, 'type' => 'monthly', 'quantity' => 1, 'reference' => 'shop-' . $orderId,
]),
CURLOPT_TIMEOUT => 30,
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) throw new RuntimeException($body['error'] . ': ' . $body['message']);
return $body['keys'];
}Python
# Python 3 with requests (server side only)
import os, requests
RINGX = "https://ringx.cc/api/v1/reseller"
HEADERS = {"Authorization": f"Bearer {os.environ['RINGX_API_KEY']}"}
def order_key(order_id: str) -> list[str]:
r = requests.post(f"{RINGX}/keys", headers=HEADERS, timeout=30,
json={"productId": 3, "type": "monthly", "quantity": 1, "reference": f"shop-{order_id}"})
data = r.json()
if not r.ok:
raise RuntimeError(f"{data['error']}: {data['message']}")
return data["keys"]Best practices
- Order the key after your payment provider confirms the payment, from your server — not from the customer’s browser.
- Use your store’s order id as
reference(for exampleshop-10045). Retries and double clicks then never cost you twice. - Save the returned keys in your own database before emailing them, so you can resend them.
- Check
GET /balanceregularly and top up before it runs out; an order without enough balance returns402and creates nothing. - If your customer cancels before using the key, refund it with
POST /keys/refund. - Point customers to ringx.cc/help for setup; the plan starts at first activation.
Questions or a higher rate limit? Contact us on Discord. Not a reseller yet? See the reseller program.