Você pode monitorar o uso da API na sua conta e aumentar os limites de uso dela, se necessário. É importante que você monitore o uso da API para não atingir o limite de taxa. Você deve ser um administrador do Zendesk Support para visualizar as páginas de uso da API na Central de administração.
- Sobre os limites padrão de uso da API
- Monitoramento do uso da API em relação ao seu limite de taxa
- Sobre o painel de uso da API
- Notificações de uso da API
- Redução do uso da API
- Aumento do limite de taxa da API
- Acompanhamento de atividades de API de trabalho com tickets em relação ao seu limite de taxa (legado)
Sobre os limites padrão de uso da API
Os limites de trabalhos com tickets e da taxa da API da Central de ajuda a seguir se aplicam aos planos Zendesk Suite e Support. Em geral, os limites de taxa da API da Central de ajuda e da API do sistema de tickets do Support são iguais, mas as solicitações à API da Central de ajuda não contabilizam no limite de taxa da API do Support. Os limites de taxa também dependem dos pontos de extremidade usados, do tempo da CPU, e assim por diante. Consulte Limites de taxa.
| Plano | Solicitações por minuto |
|---|---|
| Team | 200 |
| Growth | 400 |
| Professional | 400 |
| Enterprise | 700 |
| Complemento API para volume alto | 2500 |
Os planos Enterprise Plus incluem o complemento API para volume alto
Monitoramento do uso da API em relação ao seu limite de taxa
A Zendesk disponibiliza um resumo de uso da API para ajudar você a fazer esse monitoramento. Você pode usar esse resumo para visualizar seu uso atual e comparar a atividade com a API em relação ao seu limite de taxa.
Como monitorar o uso da API
- Na Central de administração, clique na Página inicial
na barra lateral.
É exibido um resumo do seu uso da API na página inicial da Central de administração.
O resumo exibe o uso da API (nos últimos 7 dias) em comparação com os seus limites de taxa da API. Se você exceder o seu limite, é exibido um símbolo de alerta (!) no resumo.
- Para visualizar mais informações sobre o uso da API, clique em Ver detalhes.
Você também pode seguir estas instruções para visualizar detalhes de uso da API:
- Na Central de administração, clique em
Conta na barra lateral e selecione Uso > API.
Um painel detalhado com o uso da API é exibido.
O painel exibe um resumo do uso da API suplementado por um gráfico e tabelas de uso baseado em tempo. Consulte Sobre o painel de uso da API abaixo para saber mais.
- Na Central de administração, clique em
Sobre o painel de uso da API
O painel abrange as solicitações da API ao longo do tempo, enquanto as tabelas detalham o total de solicitações de chamadores e pontos de extremidade. O conteúdo é atualizado diariamente, mas pode levar até 72 horas para que o uso atual seja refletido no painel.
Resumo de 7 dias
Os cartões de resumo de 7 dias podem incluir as informações a seguir:
- Erros 429: as violações do limite de taxa da API (respostas de HTTP 429) nos últimos sete dias, expressadas pelo percentual do número total de solicitações ao longo desse período.
- Quase violações de limite: o número de vezes que as chamadas de API são medidas entre 90% e 99% do limite do plano nos últimos sete dias.
- Abordagens de limite: o número de vezes que as chamadas de API são medidas entre 80% e 89% do limite do plano nos últimos sete dias.
Os cartões Quase violações de limite e Abordagens de limite permitem que os administradores tomem medidas proativas em relação aos erros 429.
Detalhamento das solicitações de API
Esse painel exibe o número total de solicitações de API, erros 429, Quase violações de limite e Abordagens de limite ocorridas em um período de tempo especificado.
Os clientes são identificados pelas credenciais de autenticação usadas. A tabela lista os nomes (ou identidades) de tokens de API, clientes OAuth ou usuários para autenticação básica.
O painel inclui opções detalhadas como tempo, chamador e produto.
As solicitações a seguir são excluídas da atividade:
- Solicitações que usam a autenticação da sessão, como solicitações pelos aplicativos do Zendesk ou do lado do cliente do código JavaScript na central de ajuda.
- Solicitações anônimas que não exigem autenticação, exceto a API de solicitações, se essa opção estiver ativada.
Período de tempo e granularidade
Você pode usar os menus suspensos para mostrar o gráfico por intervalo de tempo e granularidade. As opções de granularidade dependem do intervalo de tempo selecionado.
| Intervalo de tempo | Opções de granularidade | Observações |
|---|---|---|
| 1 dia | Por hora | 24 horas em intervalos por hora |
| 7 dias | Por hora, por dia | 7 dias em intervalos por hora ou por dia |
| 30 dias | Diariamente, semanalmente, mensalmente | 30 dias em intervalos diários, semanais ou mensais |
| 90 dias | Diariamente, semanalmente, mensalmente | 90 dias em intervalos diários, semanais ou mensais |
| Intervalo personalizado | Varia de acordo com o intervalo | Intervalo máximo de 90 dias |
Resumo
O painel resumido exibe o número total de solicitações de API, erros 429, Quase violações de limite e Abordagens de limite ocorridas no período de tempo especificado.
Gráfico
O gráfico de barra exibe o número de solicitações da API ao longo do tempo, com base no intervalo de tempo e na granularidade especificados. Você pode definir o gráfico para exibir os dados de uso da API em relação ao Número de solicitações ou à taxa de pico (solicitações por minuto).
- As solicitações bem-sucedidas são exibidas em azul e os erros 429 são exibidos em vermelho.
- A linha cinzenta exibe o limite de taxa da API (solicitações por minuto) da sua conta.
- Você pode passar o mouse em cada ponto de dados para obter mais informações.
A escala de horas horizontal é definida com seu horário local, sendo que a marcação na extrema direita marca o horário mais recente. A taxa de pico exibe o número mais alto de solicitações por minuto em um intervalo de tempo. Número de solicitações é a média de solicitações por minuto em um intervalo de tempo.
O gráfico é dimensionado com base na quantidade de atividades, podendo ocultar a linha de limite de taxa. Com atividades suficientes no exemplo, uma linha horizontal representando o limite de taxa apareceria na marcação de limite de taxa do seu plano.
Tabelas
A tabela abaixo do gráfico exibe as informações a seguir:
- Cinco principais chamadores com mais solicitações de API
- Cinco pontos de extremidade chamados com mais frequência com base no total de chamadas
- Cinco pontos de extremidade chamados com mais frequência com base nos erros 429
Notificações de uso da API
Quando você estiver prestes a atingir seu limite de uso da API, aparecerá um aviso do produto ou mensagens de erro. Essas mensagens são exibidas na página inicial da Central de administração e na página de uso da API.
Quando você estiver prestes a atingir seu limite de uso da API, aparecerá primeiro um aviso do produto. Veja o exemplo abaixo. O volume crítico para o aviso padrão ser exibido é de 80% do limite do plano.
Se você se aproximar ou exceder seu limite de taxa, aparecerá uma mensagem de limite crítico do produto. Veja o exemplo abaixo. O volume crítico é de 90% do limite do plano.
Redução do uso da API
Se você estiver prestes a atingir seu limite de taxa, faça apenas as solicitações necessárias. Confira áreas que podem ser exploradas para reduzir o número de solicitações:
- Otimize seu código para eliminar chamadas desnecessárias da API.
- Armazene em cache dados usados frequentemente.
- Faça o sideload de dados relacionados.
- Use pontos de extremidade em massa e lote.
Para obter mais informações, consulte Best practices for avoiding rate limiting (Práticas recomendadas para evitar limites de taxa).
Se ainda tiver problemas, você pode ser capaz de aumentar seu limite de taxa de API adquirindo o complemento API para volume alto. Consulte Aumento do limite de taxa da API neste artigo.
Aumento do limite de taxa da API
Se você estiver prestes a atingir o limite de taxa da API, ou se espera um aumento acentuado na atividade da API, pode ser capaz de adquirir um complemento para amentar os limites de uso da API da sua conta. Se você deseja adquirir o complemento API para volume alto, entre em contato com seu representante de conta ou com a equipe de vendas da Zendesk para aumentar o limite de taxa da API. Além disso, os clientes com contas qualificadas assistidas pelo departamento de vendas e contas de autoatendimento podem comprar o complemento diretamente na página de assinatura. Consulte Compra do complemento API para volume alto. Você deve ser o responsável pela conta ou o administrador de faturamento para adquirir o complemento.
O complemento API para volume alto aumenta o número de chamadas da API permitidas para um volume superior a 2.500 solicitações por minuto. O complemento já está incluído no Suite Enterprise Plus e
O complemento API para volume alto aumenta o limite qualificado do plano para 2.500 solicitações por minuto para as APIs de trabalho com tickets e da central de ajuda. Não são adicionadas mais 2.500 solicitações ao limite total do plano.
Compra do complemento API para volume alto
Se você tem uma conta qualificada assistida pelo departamento de vendas ou de autoatendimento, pode comprar o complemento API para volume alto diretamente na página de assinatura da sua conta.
Como comprar o complemento API para volume alto
-
Na Central de administração, clique no ícone Conta na barra lateral e selecione Faturamento > Assinatura.
Um resumo do plano atual será exibido.
- Clique em Gerenciar.
Se o botão Gerenciar não estiver visível na página de assinatura, então você não tem permissão para fazer alterações. Se houver produtos adicionais que você possa comprar, você verá a aba Mais produtos.
- Clique em Mais produtos.
Uma lista de produtos que você pode adicionar à sua conta será exibida, incluindo o complemento API para volume alto. O complemento API para volume alto será listado apenas se sua conta estiver qualificada para comprar o complemento no carrinho de compras.
Para saber mais sobre o complemento, clique em Saiba mais.
- Clique em Adicionar à assinatura.
O resumo da assinatura é atualizado para refletir o preço da compra.
- Clique em Atualizar assinatura para concluir a compra.
Acompanhamento de atividades de API de trabalho com tickets em relação ao seu limite de taxa (legado)
Além do resumo de uso da API, você também pode monitorar a atividade da API na seção Aplicativos e integrações da Central de administração.
Como acompanhar a atividade da API de trabalho com tickets
- Na Central de administração, clique em
Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk. - Clique na aba Atividade.
A página mostra as atividades nas últimas 24 horas. O gráfico abrange as solicitações ao longo do tempo, enquanto a tabela oferece um detalhamento do total de solicitações pelo cliente. Pico de solicitações informa o maior número de solicitações em um minuto numa determinada hora. Média de solicitações/minuto informa o número médio de solicitações por minuto durante uma determinada hora.