# 📈 Estatus de Consumo de API

Endpoint ligero para mostrar los créditos restantes de un API Key. Pensado para polling/refresh frecuente: usa cache interno (60 segundos) y degrada de forma silenciosa devolviendo 0 ante cualquier error.

  • Método: GET
  • URL de Consumo: https://api.consultaunica.mx/v3/user-stats
  • Rate limit: 10 peticiones por segundo por x-api-key.

# Ejemplo de consumo

curl https://api.consultaunica.mx/v3/user-stats \
  -H 'x-api-key: 1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4d5e6f'

# ✅ Respuesta exitosa. HTTP 200

{
  "remainingCredits": 42
}
Campo Tipo Descripción
remainingCredits int Créditos disponibles (nunca negativo). 0 indica saldo agotado o algún error interno (ver sección de errores).

# ⚠️ Manejo de errores

A diferencia de otros endpoints, este no propaga errores HTTP al cliente. La política es:

Situación Respuesta
x-api-key ausente o inválido 200 con remainingCredits=0
Fallo interno (BD/cache) 200 con remainingCredits=0
Rate limit excedido 429 Too Many Requests

Trata remainingCredits=0 como "sin créditos visibles" y no como confirmación definitiva de saldo. Para validar antes de cobrar/consumir usa el endpoint correspondiente del flujo de producto.

# 🕐 Cache

Las respuestas se cachean por 60 segundos por API Key. Esto significa que después de consumir un crédito, el valor mostrado puede estar desactualizado por hasta 60 segundos.