Os usuários podem acessar a API do Zendesk usando dois métodos de autenticação. Primeiro, podem usar a senha gerada automaticamente, chamada de token da API. Segundo, podem usar um token de acesso OAuth, que é diferente de um token da API.
Os dois métodos de autenticação estão desativados por padrão em contas novas. Este artigo explica como ativar e desativar cada método para gerenciar como os usuários acessam a API do Zendesk.
- Gerenciamento do acesso à API por meio de token da API
- Gerenciamento do acesso à API por meio de token OAuth
Para obter mais informações sobre o uso da API do Zendesk, consulte as páginas a seguir:
Gerenciamento do acesso à API por meio de token da API
Usuários podem utilizar um token da API para autenticar solicitações de API. Os tokens da API são senhas geradas automaticamente que podem ser utilizadas com seu nome de usuário para autenticar solicitações de API. Eles também podem ser usados como parte da autenticação de dois fatores para as integrações. Cada token da API pode ser utilizado por qualquer usuário verificado na conta e não está associado a um usuário específico. É possível ativar mais de um token ao mesmo tempo.
Os tokens da API não são os mesmos que os tokens de acesso OAuth. Consulte a seção sobre diferenças entre tokens da API e tokens de acesso em developer.zendesk.com.
Para usar um token da API para autenticar solicitações de API, consulte a seção sobre token da API em developer.zendesk.com.
Ativação do acesso por token da API
Por padrão, o acesso por token da API está desativado. É preciso ativar o acesso por token da API na Central de administração antes que os usuários possam usar tokens da API.
Como ativar o acesso por token da API
- Na Central de administração, clique em
Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk. - Na aba Configurações, ative o acesso por token.
Geração de tokens da API
Para gerar um token da API, você precisa ser um administrador ou o acesso por token da API deve estar ativado na sua conta.
Como gerar um token da API
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
- Clique no botão Adicionar token da API à direita de Tokens da API ativos.
O token é gerado e exibido:
- (Opcional) Insira uma descrição do token da API.
- Copie e cole o token em um local seguro. Quando você clicar em Salvar para fechar essa janela, o token completo nunca mais será exibido.
- Clique em Salvar para retornar à página da API do Zendesk.
Se você clicar no token para reabri-lo, uma versão truncada do token será exibida.
Exclusão de um token da API
Um token da API é como uma senha: qualquer usuário verificado na conta ou qualquer pessoa com o endereço de e-mail de um usuário verificado pode usá-lo para autenticar solicitações de API. Se você perceber que um token da API foi comprometido, apague-o imediatamente. A exclusão de um token o desativa permanentemente.
Como apagar um token da API
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
- Selecione o token na lista e clique em Apagar à direita.
Gerenciamento do acesso à API por meio de token OAuth
É possível usar tokens de acesso OAuth para autenticar solicitações de API. O OAuth proporciona uma maneira segura para aplicativos acessarem dados do Zendesk sem ter que armazenar e usar tokens da API, que são informações confidenciais.
Não é possível criar tokens de acesso OAuth na Central de administração, como é feito com tokens da API. Primeiro, é preciso criar um cliente OAuth na Central de administração e, em seguida, usar o cliente OAuth em um fluxo de autorização OAuth definido para criar um token de acesso OAuth.
Os tokens de acesso OAuth não são os mesmos que os tokens da API. Consulte a seção sobre diferenças entre tokens da API e tokens de acesso em developer.zendesk.com.
Esta seção abrange os tópicos a seguir:
- Criação de clientes OAuth
- Criação de tokens de acesso com um cliente OAuth
- Exclusão de clientes e tokens OAuth
Para autenticar solicitações de API com tokens de acesso OAuth, consulte a seção sobre token de acesso OAuth em developer.zendesk.com.
Criação de clientes OAuth
Os clientes OAuth permitem criar tokens de acesso OAuth que podem ser usados para autenticar solicitações de API. Os tokens de acesso OAuth são diferentes dos tokens da API. Os tokens de acesso OAuth proporcionam uma maneira segura para aplicativos acessarem a API do Zendesk sem ter que armazenar e usar os tokens da API dos usuários do Zendesk.
Como criar clientes OAuth
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
- Selecione a aba Clientes OAuth.
- Para criar um cliente,clique no botão Adicionar cliente OAuth e siga as instruções em Registro de seu aplicativo no Zendesk.
- Para apagar um cliente, selecione o cliente na lista e, em seguida, clique em Apagar à direita.
Depois, use o cliente OAuth para criar um ou mais tokens de acesso OAuth.
Criação de tokens de acesso com um cliente OAuth
Após criar um cliente OAuth na Central de administração, é possível usá-lo com um fluxo de autorização definido para criar tokens de acesso OAuth.
Também é possível usar o cliente OAuth com a API para criar tokens de acesso sem um fluxo de autorização. Você pode utilizar um token da API para autenticar essas solicitações da API. Consulte a seção sobre criação e uso de tokens de acesso OAuth com a API em developer.zendesk.com.
Exclusão de clientes e tokens OAuth
É possível apagar um cliente OAuth para desativar todos os tokens de acesso criados com o cliente. Você também pode revogar tokens de acesso individuais.
Como apagar um cliente OAuth
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > API do Zendesk.
- Selecione a aba Clientes OAuth.
- Selecione o cliente na lista e clique em Apagar à direita.
Como revogar um token de acesso específico
- Consulte a seção sobre revogar um token de acesso em developer.zendesk.com.