Como autenticar solicitações de API?

Pergunta

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

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 de senha
• Autenticação do token da API
• Autenticação do token de acesso OAuth
• Visualização do seu cabeçalho de autorização

Autenticação de senha

Observação: A autenticação de senha para nossas APIs está sendo descontinuada. O tempo pode ser diferente dependendo dos padrões de tráfego e de quando sua conta foi criada; consulte esta página: Anúncio da descontinuação do acesso por senha para APIs.

Se você usar a autenticação básica, combine seu endereço de e-mail e senha para gerar o cabeçalho de autorização. Para usar a autenticação básica, ative o Acesso por senha na Central de administração em Aplicativos e integrações > APIs > API do Zendesk, bem como na seção de autenticação relevante,seja para membro da equipe ou para usuário final.

Formate a combinação de endereço de e-mail e senha para que seja uma cadeia de caracteres Base-64 codificada. 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:password}

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 para que seja Base-64 cadeia de caracteres codificada. 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 este artigo: Uso de autenticação OAuth com seu aplicativo.

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

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

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

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

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.