Importante: A Zendesk está removendo tokens de API como um método de autenticação. A partir de 28 de julho de 2026, os tokens não utilizados serão desativados automaticamente. Até 30 de abril de 2027, todos os tokens de API deixarão de funcionar. Consulte Anúncio da remoção de tokens de API como método de autenticação para solicitações de API. 

Pergunta

Como autenticar solicitações de API usando uma das APIs do Zendesk?

Resposta

Você deve ser um usuário verificado para fazer solicitações de API autenticadas. Para autenticar as solicitações de API, você pode usar a autenticação básica com seu endereço de e-mail e senha, seu endereço de e-mail e um token da API ou um token de acesso OAuth.

Todos os métodos de autenticação definem o cabeçalho de autorização de maneira diferente. As credenciais enviadas na carga útil ou URL não são processadas. Cada opção está listada abaixo:

  • Autenticação do token da API
  • Autenticação do token de acesso OAuth
  • Visualização do seu cabeçalho de autorização

Autenticação do token da API

Se estiver usando um Token da API, combine seu endereço de email e token da API para gerar o cabeçalho de autorização. Formate a combinação de endereço de email e token da API como uma cadeia de caracteres codificada em Base-64. Para ver um exemplo de como formatar o cabeçalho de autorização, consulte o bloco de códigos abaixo.

Authorization: Basic {base-64-encoded email_address/token:api_token}

Autenticação do token de acesso OAuth

Se você usa OAuth para autenticar, formate o cabeçalho de autorização conforme mostrado abaixo:

Authorization: Bearer oauth_access_token

Para obter mais informações, consulte Uso de autenticação OAuth com seu aplicativo.

Visualização do seu cabeçalho de autorização

Aviso: Não envie tokens de API em tempo real ou de produção, tokens de acesso OAuth ou senhas de conta para ferramentas de inspeção de solicitações de terceiros ou contas de solicitações externas. Expor credenciais ativas a serviços externos cria um risco de segurança. Use tokens fictícios ou simulados ao testar cabeçalhos externamente.

Para ver exatamente o que seu aplicativo envia, use uma página de terceiro como Pipedream, anteriormente RequestBin. Compare seus cabeçalhos com os gerados por um webhook usando uma autenticação OAuth. Aponte o webhook para sua URL m.pipedream.net e, na página Adicionar webhook, clique em Testar webhook para ver isso em ação:

Adicionar página Webhook na Central de administração com o botão Testar webhook

Assim que a solicitação chega em sua requestb.in, ele aparece assim:

Pipedream request bin detalhes mostrando o cabeçalho Authorization Bearer

A cadeia de caracteres Authorization: Bearer é a chave da API fornecida por RequestBin nas configurações de sua conta em Acesso programático.

Interface da web de decodificação do Base64 mostrando cadeias de caracteres codificadas e decodificadas

Se você usa o Python para fazer solicitações, defina os cabeçalhos de sua sessão da seguinte maneira:

session = requests.Session()
session.headers = {'Content-Type': 'application/json', 'Authorization': 'Basic Basic_64_encoded_code'}
Observação: Monitore seu uso da API com o painel de Uso da API e verifique os possíveis limites de taxa.

Para obter mais informações, consulte a documentação do desenvolvedor: Segurança e autenticação.

Aviso sobre a tradução: este artigo foi traduzido por um software de tradução automática para oferecer a você uma compreensão básica do conteúdo. Medidas razoáveis foram tomadas para fornecer uma tradução precisa, no entanto, a Zendesk não garante a precisão da tradução.

Em caso de dúvidas relacionadas à precisão das informações contidas no artigo traduzido, consulte a versão oficial do artigo em inglês.

Powered by Zendesk