Ao fazer solicitações usando as APIs do Sunshine Conversations, a autenticação para verificar a identidade do chamador se torna obrigatória. Você pode usar a Autenticação básica ou os Tokens da web json (JWTs) para verificar a identidade do chamador. A chave da API é necessária para os dois métodos. Para criar a chave da API, use a página da API de conversas.
O acesso à página de API de conversas vem nos planos Zendesk Suite Professional ou superiores. Para visualizar essa página, você precisa ativar o Espaço de trabalho do agente do Zendesk. Se você precisar de mais Usuários Ativos Mensais (MAU) ou notificações, há pacotes adicionais de complementos disponíveis. Para obter mais informações, consulte Sobre os complementos da Zendesk Suite.
Este artigo inclui as seções a seguir:
Sobre as chaves da API
A chave da API identifica e autentica um aplicativo ou usuário e é composta de três itens:
- A ID do aplicativo identifica sua conta do Zendesk.
- A ID da chave quando usada com a chave secreta as credenciais são usadas para autenticar os JWTs e as chamadas da API.
- A chave secreta é a senha de autenticação.
Com a Autenticação básica, é possível fazer solicitações usando diretamente a chave da API. A ID da chave é o nome de usuário e o segredo, a senha.
Com os JWTs, os tokens são assinados com uma chave da API, que são então usados para autenticar com a API. A ID da chave é incluída no cabeçalho do JWT como a propriedade kid já o segredo assina o JWT.
As chaves da API não são tão seguras quanto os tokens de autenticação. Lembre-se de seguir as práticas recomendadas sobre administrar credenciais com segurança quando usar a chave da API em produção.
Para obter mais informações sobre a autenticação do Sunshine Conversations, consulte sobre a autenticação da API.
A chave da API do Sunshine Conversations é diferente das chaves de autenticação do recurso de mensagens. As chaves de autenticação do recurso de mensagens são usadas para assinar credenciais que autenticam usuários finais usando SDKs do Zendesk. A chave da API aqui é para chamadas entre servidores e fornece acesso às APIs públicas do Sunshine Conversations que são compatíveis com o escopo app.
Criação e compartilhamento de IDs e chave da API
O administrador do Zendesk precisa criar uma chave da API e compartilhá-la com o desenvolvedor. Você pode armazenar até 10 chaves.
Como criar e compartilhar uma chave da API
-
Na Central de administração, clique em
Aplicativos e integrações na barra lateral e selecione APIs> API de conversas.
Observação: para poder visualizar esta janela, você precisa estar em um plano Zendesk Suite Professional ou superior. - Clique em Criar chave da API.
Se você está criando a sua primeira chave, esse botão é exibido na parte inferior da página; se você já tiver criado uma chave, ele será exibido no canto superior direito.
- Na caixa de diálogo Criar nova chave, insira um nome de identificação para a chave e clique em Avançar.
- Na caixa de diálogo Copiar segredo compartilhado, clique em Copiar para cada ID e chave secreta para salvá-la na área de transferência e clique em Avançar.
Você será redirecionado para a janela da API, onde você verá a nova chave na lista.
Se você gerar um nova chave, mas atingir o número máximo de 10, verá uma notificação pedindo que apague as chaves não utilizadas.
Como apagar uma chave não utilizada
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs> API de conversas.
- Passe o cursor sobre a chave que você deseja apagar, clique no menu de opções (
) e selecione Apagar. - Para confirmar a ação, clique em Apagar.