Uso do painel da API

A API do Zendesk é suportada por um painel na Central de administração. O painel da API permite que você realize as seguintes tarefas:

• Habilitação de acesso por senha ou token
• Criação e gerenciamento de tokens de API
• Criação e gerenciamento de clientes OAuth
• Acompanhamento de atividades de API em relação ao seu limite de taxa
• Obter informações sobre falhas de alvo da URL.

Somente os administradores do Zendesk Support podem acessar o painel da API.

Observação: as contas de avaliação têm um limite de, no máximo, dois alvos.

Para obter mais informações sobre o uso da API do Zendesk, consulte as páginas a seguir:

• Introdução à REST API em developer.zendesk.com
• Guia da API do Zendesk em help.zendesk.com
• Comunidade de API do Zendesk

Habilitação de acesso por senha ou token

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
2. Na aba Configurações, ative o acesso por senha ou token.

Criação e gerenciamento de tokens de API

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
2. Verifique se a aba Configurações está selecionada.
3. Para criar um token, clique no sinal de adição (+) no lado direito.
4. Para apagar um token, clique no token na lista e em Apagar à direita.

É possível ativar mais de um token ao mesmo tempo. A exclusão de um token o desativa permanentemente.

Para mais informações, consulte Tokens de API em developer.zendesk.com.

Criação e gerenciamento de clientes OAuth

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
2. Selecione a aba Clientes OAuth.
3. Crie um cliente conforme as instruções em Registro de seu aplicativo no Zendesk.

Acompanhamento de atividades de API em relação ao seu limite de taxa

Você pode comparar as atividades nas últimas 24 horas com a Core API com relação a seu limite de taxa.

Como monitorar a atividade da API

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
2. Clique na aba Atividade.

As solicitações a seguir são excluídas da atividade:

• Central de Ajuda e solicitações de API do Talk
• 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

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. 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 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 700 solicitaçõ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.

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.

Observação: o gráfico não engloba limites de taxa específicos do ponto de extremidade, como aqueles para Exportações incrementais.

Obter informações sobre falhas de alvo da URL.

Se você estiver tendo problemas com um alvo da URL, veja as informações retornadas pelo serviço de terceiros ou pela REST API que o destino tentou acessar.

Como visualizar informações de falhas do alvo

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
2. Clique na aba Falhas de alvo.

Exemplo:

Clique no item da lista para obter informações detalhadas sobre a falha.

Observação: as informações sobre falhas são provenientes da resposta enviada pelo serviço de terceiros. Consulte a documentação do serviço para obter ajuda na solução de problemas.