API Keys

La API de oxb te deja leer y controlar tu servidor desde tus propias herramientas: un bot de Discord, tu web, un panel propio. Cada API Key pertenece a una licencia y solo devuelve los datos de ese servidor.

Crear una key#

1. 1

   Abre Panel → API Keys

   Pulsa Crear API Key, ponle un nombre y elige el servidor al que pertenece.

2. 2

   Guarda la clave secreta

   Se muestra una sola vez. Copia la clave de acceso y la clave secreta en un lugar seguro.

3. 3

   Úsala en tus peticiones

   Se envían en dos cabeceras: x-api-key (acceso) y x-api-secret (secreta).

curl -X POST https://api.oxbservices.com/v1/auth/verify \
  -H "x-api-key: TU_CLAVE_DE_ACCESO" \
  -H "x-api-secret: TU_CLAVE_SECRETA"

{
  "valid": true,
  "key": { "id": "…", "name": "Mi bot", "status": "ACTIVE", "totalRequests": 12 },
  "server": { "id": "…", "name": "Mi servidor", "licenseExpiresAt": "2027-02-01T00:00:00.000Z" },
  "rateLimit": { "limit": 120, "window": "1m" }
}

Reglas#

• Una key por servidor. Para crear otra, borra la anterior.
• La key funciona mientras la licencia del servidor esté vigente (ni caducada ni baneada).
• Límite: 120 peticiones por minuto por key. Cada respuesta incluye X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset.
• Nunca pongas una API Key en un recurso del cliente ni en un repositorio público.

Errores#