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 /span>usuário verificado para fazer solicitações de API. Você pode autenticar solicitações de API usando a autenticação básica com seu endereço de email e senha, com seu endereço de email e um token da API ou com 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 no payload ou URL não são processadas.

Este artigo inclui informações sobre os seguintes tópicos:

• Senha
• Token da API
• Token de acesso OAuth
• Visualização do seu cabeçalho de autorização

Senha

Se você usar a autenticação básica, combine seu endereço de email e senha para gerar o cabeçalho de autorização. A combinação de endereço de email e senha precisa ser uma sequência de caracteres codificada em Base 64. Formate o cabeçalho de autorização conforme abaixo.

Authorization: Basic {base-64-encoded email_address:password}

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. A combinação de endereço de email e token da API precisa ser uma sequência de caracteres codificada em Base 64. Formate o cabeçalho de autorização conforme abaixo.

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

Token de acesso OAuth

Se você usa OAuth para autenticar, formate o cabeçalho de autorização conforme 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

Se você quiser ver exatamente o que é enviado pelo seu aplicativo, use uma página de terceiros como a Caixa de solicitações. Compare seus cabeçalhos com os gerados por um web hook usando uma autenticação OAuth. Aponte o webhook para seu URL requestb.in e , e na página Adicionar webhook, clique em Testar webhookpara ver isso em ação:

Uma vez atingido seu 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'}

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