Developer Portal • v1.0

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 / CodeDescription
X-RateLimit-LimitPlan's daily request limit (500 / 50k / 500k / 5M)
X-RateLimit-RemainingRemaining calls before 00:00 UTC reset
X-RateLimit-ResetUTC midnight Unix timestamp
X-Cache-StatusHIT, MISS, or STALE (upstream fallback)
401 / 403 / 404 / 429Auth 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

EndpointAuthNotes
GET /api/health & GET /api/readyPublicService health, readiness, and cache freshness status
GET /api/special-zonePublicSpecial Game Zone links
POST /api/auth/register, login, refresh, logoutPublic / JWTArgon2id + refresh token rotation + 2FA
GET/POST /api/customer/*Bearer JWTKeys, analytics, logs, webhooks, payments, invoices, tickets
GET/POST/PATCH /api/admin/*Admin JWTRBAC 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.