DPBoss REST API Reference
Interactive developer documentation with live endpoint testing, response header inspection, rate limit details, and 5-language client snippets.
Authentication
Send your API key (dpb_live_...) to any /v1/* route via header (recommended):
x-api-key: dpb_live_YOUR_API_KEY # OR Authorization: Bearer dpb_live_YOUR_API_KEY # Legacy (deprecated; emits Deprecation header): GET /v1/live?api_key=dpb_live_YOUR_API_KEY
Rate Limits & Error Reference
| Header / Code | Description |
|---|---|
X-RateLimit-Limit | Plan's daily request limit (500 / 50k / 500k / 5M) |
X-RateLimit-Remaining | Remaining calls before 00:00 UTC reset |
X-RateLimit-Reset | UTC midnight Unix timestamp |
X-Cache-Status | HIT, MISS, or STALE (upstream fallback) |
401 / 403 / 404 / 429 | Auth invalid / Suspended or IP blocked / Not found / Daily quota exceeded |
Quick Integration Examples
# cURL
curl -s -H "x-api-key: dpb_live_KEY" "http://localhost:3000/v1/live?search=kalyan"
# Node.js
const res = await fetch("http://localhost:3000/v1/live", { headers: { "x-api-key": "dpb_live_KEY" } });
# Python
import requests
requests.get("http://localhost:3000/v1/live", headers={"x-api-key": "dpb_live_KEY"}).json()
Public & Platform Management APIs
| Endpoint | Auth | Notes |
|---|---|---|
GET /api/health & GET /api/ready | Public | Service health, readiness, and cache freshness status |
GET /api/special-zone | Public | Special Game Zone links |
POST /api/auth/register, login, refresh, logout | Public / JWT | Argon2id + refresh token rotation + 2FA |
GET/POST /api/customer/* | Bearer JWT | Keys, analytics, logs, webhooks, payments, invoices, tickets |
GET/POST/PATCH /api/admin/* | Admin JWT | RBAC user management, plans, payment verification, scraper & audit logs |
Version History & Changelog
v2.0.0 (Production Upgrade): Modular controller/repository architecture, MySQL 8 migrations, Redis caching + BullMQ workers, Argon2id + 2FA + RBAC, webhooks, invoicing, and Hybrid Dark/Light SaaS UI while preserving 100% of v1 contracts.