Ponto final de utilização
Recupere as estatísticas de uso atuais da API para sua chave de API.
O endpoint de Uso retorna estatísticas de uso em tempo real para sua chave de API autenticada, incluindo contagens de solicitações diárias e mensais, limites de taxa e seu plano de assinatura atual.
https://api.allnewsapi.com/usageParâmetros de consulta
Nome | Tipo | Valor padrão | Descrição |
|---|---|---|---|
apikeyObrigatório | string | — | Sua chave de API para autenticação. Obtenha sua chave de API no painel de controle. |
Resposta
A API retorna um objeto JSON contendo suas estatísticas de uso atuais.
Nome | Tipo | Valor padrão | Descrição |
|---|---|---|---|
workspaceId | string | — | O identificador do espaço de trabalho ao qual a chave da API pertence. |
workspaceName | string | — | O nome de exibição do espaço de trabalho ao qual a chave da API pertence. |
plan | string | — | Seu plano de assinatura atual (gratuito, inicial, profissional, empresarial, corporativo) |
requestsUsed24Hours | integer | — | Número de solicitações de API feitas na janela atual de 24 horas. |
requestsLimit24Hours | integer | — | O número máximo de solicitações permitidas por dia no seu plano atual. |
requestsRemaining24Hours | integer | — | O número de solicitações restantes antes de atingir o limite diário. |
requestsUsed30Days | integer | — | Número de requisições à API feitas no mês atual. Este contador é zerado no dia 1º de cada mês (o nome do campo JSON permanece requestsUsed30Days para manter a compatibilidade com versões anteriores). |
overageEnabled | boolean | — | Se a cobrança por excesso de uso está habilitada para o espaço de trabalho. |
overageRequests24Hours | integer | — | Número de solicitações atendidas por meio de excedente no período de 24 horas atual (0 quando o excedente está desativado). |
Exemplo de resposta
Exemplo de solicitação
Erros
| Status | Condition |
|---|---|
401 | Chave de API inválida ou desconhecida |
403 | A chave da API está desativada. |
422 | O parâmetro apikey está faltando na solicitação. |