Glosario

Una referencia de los términos que encontrará en la documentación, el panel de control y las respuestas de la API.

Una cadena secreta utilizada para autenticar las solicitudes de API. Cada clave pertenece a un tenant y tiene un alias, una categoría, cuotas opcionales y una fecha de expiración opcional. Se transmite mediante el encabezado x-api-key o el parámetro de consulta x_api_key.

Consulte Claves API para todos los detalles.

Top-up API

Compra puntual que añade cuota API consumible una vez. Los top-ups no se reinician cada período. Las llamadas consumen primero la suscripción, luego los top-ups hasta agotarlos.

Compre top-ups desde la facturación del panel o la página de precios.

Alias

El nombre legible de una clave API, único dentro de un tenant. Se usa para identificar claves en el panel de control y los análisis.

Recarga automática

Función que compra automáticamente un pack puntual cuando su saldo restante (cuota API + créditos extra) cae por debajo de un umbral configurado. Protegida por un período de espera de 72 horas entre compras. Requiere una suscripción de pago activa.

Consulte Recarga automática para todos los detalles.

Período de facturación

La ventana de suscripción activa utilizada para medir el consumo de cuota. Determinada por los campos currentPeriodStart y currentPeriodEnd de Stripe. Si no se encuentra una suscripción activa, el período de facturación es el mes natural actual.

Categoría

Una etiqueta en una clave API (production, development, staging o personalizada). Se usa para filtrado y organización en el panel de control. No cambia cómo la API procesa la solicitud.

Crédito

La unidad de consumo de la API. Cada solicitud facturable deduce un número de créditos determinado por el coste del endpoint. Los créditos se almacenan como entradas de libro mayor: un importe negativo significa que se concedieron créditos, un importe positivo significa que se consumieron.

Consulte Créditos para el coste por endpoint.

Créditos adicionales

Créditos en un saldo separado, distinto de la cuota API. Se usan solo cuando la cuota API combinada (suscripción + top-ups) está totalmente agotada. No se reinician al final del período de facturación. Fuentes: onboarding o compras manuales de créditos extra.

Cuota por clave

Un límite de solicitudes opcional establecido en una clave API específica. Aplicado en ventanas de tiempo deslizantes: total histórico, últimas 24 horas, 7 días y 30 días. Independiente de la cuota de suscripción.

Plan

Un producto de suscripción (p. ej. "Starter", "Pro") que define un conjunto de características: cuota de llamadas API, límites de tasa, acceso a créditos adicionales y más. Un tenant puede tener varios productos de plan activos simultáneamente.

Cuota

Presupuesto combinado de llamadas API (suscripción + top-ups restantes), ponderado por el coste en créditos de cada endpoint. La parte de suscripción se reinicia cada período; los top-ups se consumen una vez. Cuando la cuota API se agota, se usan créditos extra si están disponibles; de lo contrario, 402.

Límite de tasa

Existen dos sistemas de limitación de tasa separados. Los límites de plan (por segundo / por minuto) se aplican a todas las claves de una cuenta y son establecidos por el plan de suscripción. Superarlos devuelve 429 Too Many Requests. Las cuotas por clave (ventanas deslizantes total / diario / semanal / mensual) son límites máximos opcionales configurados por clave. Superarlos devuelve 401 Rate Limit Exceeded. Consulte Claves API para más detalles.

Glosario

Cuenta

Clave API