Gerenciamento de clientes de API do Chat e tokens

Esse artigo fornece a você uma visão geral de como gerenciar clientes de API do Chat e tokens OAuth. Ele orienta você sobre como criar e apagar clientes existentes, além de criar e revogar tokens de acesso OAuth.

Os clientes de API são usados para criar tokens de acesso OAuth para autenticar solicitações da API. Se você está em uma conta apenas do Chat legado, existem dois modos de autenticação de solicitações da API:

• autenticação básica com nome de usuário e senha
• token de acesso OAuth

Se você está na conta do Chat+Support ou na fase 4, existe apenas um modo de autenticação de solicitações da API:

• token de acesso OAuth

Para obter mais informações sobre outros tipos de conta do Chat, consulte Sobre tipos de conta do Chat. Para obter detalhes sobre a autenticação da API, consulte a página sobre segurança e autenticação nos documentos da API do Chat.

Este artigo abrange as seções a seguir:

• Gerenciamento de clientes de API
• Criação de clientes de API
• Exclusão de clientes de API
• Criação de tokens
• Revogação de tokens
• Recursos adicionais

Gerenciamento de clientes de API

Os administradores podem facilmente ver e apagar os clientes de API ativos da interface do Chat. Os usuários podem ver apenas os clientes criados por eles.

Para visualizar seus clientes ativos, acesse o painel do Chat e selecione Configurações > Conta > API e SDKs.

Nesse local, é possível selecionar os clientes que você deseja visualizar ou atualizar. Também é possível gerar novamente o segredo do cliente ou apagar o cliente.

Criação de clientes de API

Se você está criando tokens OAuth para uso interno, siga estas instruções. Se o cliente é para uma integração de terceiros, siga as instruções de instalação fornecidas pelo desenvolvedor.

Para criar um cliente, acesse o painel do Chat e selecione Configurações > Conta > API e SDKs e clique no botão Adicionar cliente de API.

Para obter instruções detalhadas sobre o preenchimento de campos de cliente, consulte a página sobre adição de um cliente de API na documentação da API do Chat.

Exclusão de clientes de API

Antes de apagar um cliente, é importante verificar se essa ação afetará os serviços de terceiros. Se o seu cliente tem um campo de URL de redirecionamento definido com outra URL que não seja localhost, é provável que o cliente esteja interagindo com uma integração externa. Se você apagar o cliente, precisará criar outro. Durante o processo de criação do token, os usuários da integração externa precisarão conceder à integração acesso à sua conta do Chat novamente. Se a URL de redirecionamento for localhost, o cliente provavelmente foi criado para uso interno da API.

Como apagar um cliente

1. No painel do Chat, selecione Configurações > Conta > API e SDKs e, em seguida, o cliente da lista.
2. Clique no botão Apagar selecionados.

Você pode também usar a API para gerenciar os clientes de API. Consulte a página sobre clientes OAuth na documentação da API.

Criação de tokens

Agora que você já tem o cliente de API, pode criar um token de acesso OAuth para autenticar as solicitações da API.

Há duas maneiras de criar um token de acesso: uma mais longa e formal para ambientes de produção e outra mais curta e conveniente para ambientes de teste.

Para obter instruções sobre os dois métodos, consulte Geração de um token da REST API para contas do Chat integrado.

Revogação de tokens

Um token só pode ser revogado pelo usuário que o criou. Os administradores não têm permissão para revogar tokens criados por outros usuários.

Para revogar um token, consulte a página sobre a API de tokens OAuth. O procedimento consiste nas seguintes etapas:

1. Liste seus tokens para obter a ID do token que você deseja apagar.
   
   Consulte a lista de tokens na documentação da API.
   
   Se você tem muitos tokens, é fácil encontrar o token desejado sabendo a data e hora aproximadas da criação do token.
   
   
2. Revogue o token pela ID.
   
   Consulte a página sobre a revogação de tokens na documentação da API.

Recursos adicionais

Esse artigo fornece a você uma visão geral sobre clientes de API do Chat e tokens de acesso OAuth. Para obter mais informações, consulte os seguintes artigos:

• Sobre a autenticação OAuth na documentação da API do Chat
• Geração de um token da REST API para o Chat