Glossário
Definições dos termos-chave usados na API e no painel de controle.
Uma referência dos termos que você encontrará na documentação, painel de controle e respostas da API.
Conta
Veja Tenant.
Chave de API
Uma string secreta usada para autenticar solicitações de API. Cada chave pertence a um tenant e tem um alias, uma categoria, cotas opcionais e uma data de expiração opcional. Transmitida via cabeçalho x-api-key ou parâmetro de consulta x_api_key.
Consulte Chaves de API para todos os detalhes.
Top-up API
Compra avulsa que adiciona cota API consumível uma vez. Top-ups não se redefinem a cada período. Chamadas consomem primeiro a assinatura, depois os top-ups até esgotar.
Compre top-ups na faturação do painel ou na página de preços.
Alias
O nome legível de uma chave de API, único dentro de um tenant. Usado para identificar chaves no painel de controle e análises.
Recarga automática
Funcionalidade que compra automaticamente um pacote avulso quando seu saldo restante (cota API + créditos extras) cai abaixo de um limite configurado. Protegida por um período de espera de 72 horas entre compras. Requer assinatura paga ativa.
Consulte Recarga automática para todos os detalhes.
Período de faturamento
A janela de assinatura ativa usada para medir o consumo de cota. Determinada pelos campos currentPeriodStart e currentPeriodEnd do Stripe. Se nenhuma assinatura ativa for encontrada, o período de faturamento é o mês calendário atual.
Categoria
Um rótulo em uma chave de API (production, development, staging ou personalizado). Usado para filtragem e organização no painel de controle. Não altera como a API processa a solicitação.
Crédito
A unidade de consumo da API. Cada solicitação faturável deduz um número de créditos determinado pelo custo do endpoint. Os créditos são armazenados como entradas de razão: um valor negativo significa que créditos foram concedidos, um valor positivo significa que foram consumidos.
Consulte Créditos para o custo por endpoint.
Créditos extras
Créditos em um saldo separado, distinto da cota API. Usados somente após esgotamento total da cota API (assinatura + top-ups). Não são redefinidos ao final do período de faturamento. Fontes: onboarding ou compras manuais de créditos extras.
Cota por chave
Um limite de solicitações opcional definido em uma chave de API específica. Aplicado em janelas de tempo deslizantes: total histórico, últimas 24 horas, 7 dias e 30 dias. Independente da cota de assinatura.
Plano
Um produto de assinatura (p. ex. "Starter", "Pro") que define um conjunto de funcionalidades: cota de chamadas de API, limites de taxa, acesso a créditos extras e mais. Um tenant pode ter vários produtos de plano ativos simultaneamente.
Cota
Orçamento combinado de chamadas API (assinatura + top-ups restantes), ponderado pelo custo em créditos de cada endpoint. A parte da assinatura é redefinida a cada período; top-ups são consumidos uma vez. Quando a cota API esgota, créditos extras são usados se disponíveis; caso contrário, 402.
Limite de taxa
Existem dois sistemas de limitação de taxa separados. Limites de plano (por segundo / por minuto) se aplicam a todas as chaves de uma conta e são definidos pelo plano de assinatura. Excedê-los retorna 429 Too Many Requests. Cotas por chave (janelas deslizantes total / diária / semanal / mensal) são limites máximos opcionais configurados por chave. Excedê-los retorna 401 Rate Limit Exceeded. Consulte Chaves de API para detalhes.
Assinatura
Um acordo de faturamento recorrente vinculando um tenant a um ou mais planos. Gerenciado via Stripe. Determina o período de faturamento, a cota e as funcionalidades disponíveis para o tenant.
Tenant
A unidade organizacional na plataforma, equivalente a uma conta ou espaço de trabalho. Todas as chaves de API, uso, créditos e assinaturas são limitados a um tenant. Os usuários podem pertencer a vários tenants. Veja Conta.
Limite
A porcentagem de saldo restante (cota API + créditos extras) em que a recarga automática é ativada. Configurável entre 10% e 30%.