ChartQuery

Claves API

Cree, configure y gestione claves API desde su panel de control.

Las claves API autentican sus solicitudes a la API. Las gestiona completamente desde el panel de control: establezca una categoría, restrinja el uso con cuotas deslizantes, añada una fecha de expiración y monitorice la actividad por clave a través de los registros de solicitudes.

Para saber cómo incluir una clave en una solicitud, consulte la Introducción.

Crear una clave

Completar los campos

Asigne a la clave un alias (etiqueta única para su referencia), elija una categoría y opcionalmente configure cuotas y una fecha de expiración.

Copiar el secreto

Tras guardar, el secreto se muestra una sola vez. Cópielo inmediatamente y guárdelo en una variable de entorno. No puede recuperarse de nuevo.

Campos de la clave

CampoDescripción
AliasEtiqueta única por cuenta. Aparece en registros y filtros del panel de control.
CategoríaEtiqueta de organización (véase Categorías). No tiene efecto en el comportamiento de la API.
ActivaActiva o desactiva la clave. Las claves inactivas se rechazan inmediatamente con 401 Inactive API Key.
ExpiraFecha opcional tras la cual la clave deja de funcionar. Deje en blanco para no tener expiración.
Cuotas de solicitudesLímites opcionales por clave en ventanas deslizantes (véase Cuotas por clave).

Categorías

Las categorías etiquetan las claves para su organización. Aparecen en los filtros y análisis del panel de control pero no cambian cómo la API procesa una solicitud.

CategoríaUso típico
productionTráfico en vivo, sistemas orientados al cliente
developmentDesarrollo local y pruebas
stagingEntornos de preproducción y CI
PersonalizadaCualquier etiqueta libre, p. ej. sandbox, partner-acme

Mantenga una clave por entorno para poder revocarla o rotarla de forma independiente.

Cuotas por clave

Cada clave puede tener límites máximos independientes sobre el volumen de solicitudes, aplicados en ventanas deslizantes (no límites de calendario):

CuotaVentana
TotalHistórico: la clave se bloquea permanentemente una vez alcanzado
DiariaÚltimas 24 horas (deslizante, no de medianoche a medianoche)
SemanalÚltimos 7 días (deslizante)
MensualÚltimos 30 días (deslizante)

Deje un campo en blanco para no aplicar límite para esa ventana. Cuando se alcanza una cuota, la API devuelve 401 Rate Limit Exceeded con el nombre de la cuota en el mensaje:

{ "error": "Rate limit exceeded: quota total" }
{ "error": "Rate limit exceeded: quota daily" }
{ "error": "Rate limit exceeded: quota weekly" }
{ "error": "Rate limit exceeded: quota monthly" }

Los contadores de cuota se agregan desde los registros de solicitudes y se almacenan en caché hasta 24 horas. La aplicación es precisa dentro de esa ventana, no a la solicitud exacta.

Las cuotas por clave son distintas de los límites de tasa a nivel de plan (límites por segundo y por minuto que se aplican a toda la cuenta). Los límites de plan devuelven 429 Too Many Requests. Consulte Gestión de errores para más detalles.

Expiración

Establezca una fecha de expiración en claves usadas en scripts, pipelines de CI o integraciones con socios. Una vez superada la fecha, la API devuelve:

{ "error": "Expired API Key" }

Código de estado HTTP 401. Cree y despliegue una clave de reemplazo antes de la fecha de expiración para evitar interrupciones.

Registros de solicitudes

Cada solicitud realizada con una clave queda registrada en Claves API → Registros en el panel de control. Cada entrada muestra:

CampoDescripción
EndpointMétodo HTTP y ruta
EstadoCódigo de estado de la respuesta
DuraciónTiempo hasta el primer byte (ms)
IPDirección IP del llamante
CréditosCréditos cobrados por esta solicitud

Use los registros para auditar la actividad por clave, depurar errores inesperados o identificar tráfico de claves comprometidas.

Desactivar vs. eliminar

AcciónEfecto
DesactivarLa clave se bloquea inmediatamente. El historial de uso y los ajustes se conservan. Puede reactivarse.
EliminarElimina permanentemente la clave y su configuración. Solo es posible si la clave nunca ha sido usada.

Prefiera la desactivación a la eliminación. Si una clave tiene historial de solicitudes, no puede eliminarse. El historial se conserva para facturación y auditoría.

Rotación de una clave

Crear la clave de reemplazo

Vaya a panel de control → Claves API → Nueva y cree una nueva clave con los mismos ajustes de categoría y cuota. Asígnele un nuevo alias para distinguirla.

Desplegar la nueva clave

Actualice la variable de entorno en cada sistema que use la clave antigua y vuelva a desplegar.

Desactivar la clave antigua

Establezca la clave antigua como inactiva en el panel de control. Esto bloquea las solicitudes restantes sin eliminar su historial.

Referencia de errores

ErrorEstadoCausa
Invalid API Key401Clave no encontrada o malformada
Inactive API Key401Clave desactivada
Expired API Key401La clave ha superado su fecha de expiración
Rate limit exceeded: quota …401Cuota deslizante por clave alcanzada
exceeded the … rate limit on your subscription429Límite por segundo o por minuto a nivel de plan
IP temporarily blocked403Demasiados intentos de autenticación fallidos desde la misma IP

Véase también: Buenas prácticas para directrices de seguridad y Glosario para definiciones de términos.

En esta página