Docs
EN

Objetivo

Entiende cuántas validaciones has consumido en el ciclo de facturación actual, dónde estás en relación al límite mensual de tu plan, qué operaciones representan la mayor parte del consumo y cómo han cambiado los patrones de uso con el tiempo. Usa estas señales para planificar eventos de escalado y para construir alertas de uso en tu propio stack de monitoreo.

Requisitos previos

  • Una API key activa (mxcep_…). No se requiere permiso adicional más allá de la autenticación para los endpoints de uso.

Pasos

1. Verificar el snapshot de cuota del ciclo actual

GET /v1/usage/summary devuelve el límite mensual de tu plan, validaciones consumidas, validaciones restantes y un indicador tone preclasificado (ok, warn, danger, none).

curl 'https://api.example.com/v1/usage/summary' \
  -H 'Authorization: Bearer mxcep_••••'
{
  "data": {
    "type": "usage_summary",
    "attributes": {
      "limit": 5000,
      "used": 2100,
      "remaining": 2900,
      "percent_used": 42.0,
      "tone": "ok",
      "resets_at": "2025-05-01T00:00:00Z"
    }
  }
}

Umbrales del tone:

toneSignificado
okPor debajo del 70% consumido.
warn70–89% consumido.
danger90%+ consumido.
noneEl plan no tiene límite mensual.

2. Obtener contadores crudos de uso de API

GET /v1/api/usage proporciona un snapshot más amplio que incluye peticiones de hoy, peticiones del mes, cuota del plan y el estado actual del servicio Banxico.

curl 'https://api.example.com/v1/api/usage' \
  -H 'Authorization: Bearer mxcep_••••'
{
  "data": {
    "requests_today": 42,
    "requests_month": 580,
    "quota": {
      "plan_slug": "basic",
      "limit": 1000,
      "used": 420,
      "remaining": 580,
      "resets_at": "2025-04-01T00:00:00Z"
    }
  }
}

3. Verificar límites de tasa

Tu plan aplica límites por minuto o por hora además de la cuota mensual. Consulta los límites configurados con:

curl 'https://api.example.com/v1/usage/limits' \
  -H 'Authorization: Bearer mxcep_••••'

Esto devuelve los caps definidos por el plan (p. ej. peticiones por minuto) de forma separada al conteo de cuota mensual.

4. Inspeccionar el desglose por operación

Ve qué endpoints consumen más cuota en el ciclo actual:

curl 'https://api.example.com/v1/usage/breakdown' \
  -H 'Authorization: Bearer mxcep_••••'

5. Ver tendencias históricas de uso

GET /v1/usage/history devuelve datos de uso agrupados por tiempo. Combínalo con el endpoint de tendencias de insights para análisis de series temporales más enriquecidos.

curl 'https://api.example.com/v1/usage/history' \
  -H 'Authorization: Bearer mxcep_••••'

6. Ver el mapa de calor de uso

GET /v1/usage/heatmap muestra la densidad de actividad por hora del día y día de la semana — útil para entender las ventanas de uso pico.

curl 'https://api.example.com/v1/usage/heatmap' \
  -H 'Authorization: Bearer mxcep_••••'

7. Exportar datos de uso

Descarga datos de uso crudos como CSV o XLSX para ingestión en tu pipeline de analítica:

curl 'https://api.example.com/v1/api/usage/export?format=csv' \
  -H 'Authorization: Bearer mxcep_••••' \
  --output exportacion-uso.csv

Siguientes pasos