# Tokens de API ### **O que é a área de Integrações?** A seção de **Integrações** é o seu centro de controle para conectar a plataforma Omnichannel a outras ferramentas e sistemas que sua empresa utiliza e também fazer consultas próprias da plataforma. Para que essa comunicação aconteça de forma segura, é necessário criar uma "senha" especial, conhecida como **Chave de API** ou **Bearer Token**. Pense nela como uma chave de acesso exclusiva que autoriza um sistema externo a acessar ou enviar informações para sua conta Omnichannel, sem precisar de seu login e senha de usuário. ### **Passo a Passo para Gerar sua Chave de API** **Etapa 1: Localize a seção de Integrações** Acesse o menu principal da nossa plataforma e clique na opção **"Integrações"**. O GIF abaixo demonstra o caminho exato. ![](https://s3.us-east-2.amazonaws.com/convert-company-outline/uploads/da620569-2861-4ee9-be7a-ce37f317a1fa/f82ec9ac-f685-4131-aa20-b8817debe745/integra%C3%A7%C3%B5es.gif?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAWNEQDAE74GWO55AJ%2F20260922%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260922T151500Z&X-Amz-Expires=86400&X-Amz-Signature=aebbf28d40fcb91ab32d2ccc384f6f8997af93583f17be3b8364042198952f70&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =1893x947") **Etapa 2: Inicie o cadastro de uma nova chave** Você verá a tela de gerenciamento de suas chaves de API. Para adicionar uma nova, clique no botão **"Criar Novo"**. ![](https://s3.us-east-2.amazonaws.com/convert-company-outline/uploads/da620569-2861-4ee9-be7a-ce37f317a1fa/117b03d7-e5ef-471e-a58d-dcb947c5c355/image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAWNEQDAE74GWO55AJ%2F20260922%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260922T151500Z&X-Amz-Expires=86400&X-Amz-Signature=595ee894321463c58bf9f470734488e830cb92a565031bee8937de34446411ab&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject) **Etapa 3: Identifique sua chave** No formulário que aparecer, dê um nome e uma descrição para sua chave. * **Nome:** Escolha um nome claro e objetivo. * *Exemplo bom:* `integracoes_api_convert` * *Exemplo ruim:* `chave123` * O nome deve sempre ser em minúsculo Isso é fundamental para que você possa gerenciar suas integrações no futuro, sabendo exatamente qual chave pertence a qual sistema. ![](https://s3.us-east-2.amazonaws.com/convert-company-outline/uploads/da620569-2861-4ee9-be7a-ce37f317a1fa/ed8373f8-017e-416a-9d1b-c1796fa21e11/image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAWNEQDAE74GWO55AJ%2F20260922%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260922T151500Z&X-Amz-Expires=86400&X-Amz-Signature=ebaefd35b65dddfbe10787aeda92cd776f237944ca41c7a97e6e10f5b1883432&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject) **Etapa 4: Copie e salve seu Token Gerado** Pronto! Sua chave de acesso (*Bearer Token*) foi criada e será exibida na tela. :::warning **ALERTA DE SEGURANÇA** Este é o único momento em que o token completo será exibido. Copie-o e guarde-o em um gerenciador de senhas ou em outro local seguro. Uma vez que você saia desta tela, não será possível recuperar o mesmo token. Caso o perca, você precisará revogar a chave antiga e gerar uma completamente nova. ::: ![](https://s3.us-east-2.amazonaws.com/convert-company-outline/uploads/da620569-2861-4ee9-be7a-ce37f317a1fa/46ab9467-1468-428b-a6e2-9fe81d356ae4/image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAWNEQDAE74GWO55AJ%2F20260922%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260922T151500Z&X-Amz-Expires=86400&X-Amz-Signature=e73586247a24d8c7ec623d7614722be973af70f99597638e39fd20591f2a24f9&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject) ### **Próximos Passos** Com o seu *Bearer Token* em mãos, você está pronto para autenticar suas requisições na nossa API. Para saber quais funcionalidades estão disponíveis e como utilizá-las, por favor, consulte a [documentação completa da API Omnichannel.](https://developers.convert.app.br/docs/api/developers-omnichannel/api-v1) ### **Como Revogar e Substituir uma Chave de API** Pode haver momentos em que você precise substituir uma chave de API, seja por motivos de segurança (como a suspeita de que a chave foi exposta) ou simplesmente para renovar suas credenciais. O ato de revogar uma chave a torna permanentemente inativa. **Siga os passos abaixo para revogar uma chave existente e gerar uma nova em seu lugar:** 1. **Navegue até Integrações** e localize a chave que deseja substituir. A identificação será feita pelo nome que você deu a ela durante a criação. 2. Ao lado do nome da chave, clique no ícone de **chave** ou **"Gerar token"** (**🔑**). 3. O sistema exibirá uma mensagem de confirmação para garantir que a ação não seja acidental. Leia com atenção e, se tiver certeza, **confirme a operação**. ![](https://s3.us-east-2.amazonaws.com/convert-company-outline/uploads/da620569-2861-4ee9-be7a-ce37f317a1fa/af629bf9-e17b-4f01-aaac-dc35dd890c29/integra%C3%A7%C3%B5es_revoke_token.gif?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAWNEQDAE74GWO55AJ%2F20260922%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260922T151500Z&X-Amz-Expires=86400&X-Amz-Signature=e6200a436d04171abcedb3e9d2ca9db24e04ab64d51db6f67130eba3c5c62e21&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =1511x947") :::info **AÇÃO IRREVERSÍVEL E DE ALTO IMPACTO** * Ao confirmar, o token antigo será **imediatamente e permanentemente invalidado**. * Qualquer sistema, aplicação ou serviço que estiver utilizando o token antigo **perderá o acesso na mesma hora**. * Um **novo token será gerado** e exibido na tela. Assim como na criação inicial, você deve **copiá-lo e guardá-lo em local seguro**, pois ele não será mostrado novamente. * Você precisará **atualizar a nova chave em todos os sistemas** que utilizavam a antiga para restaurar a integração. ::: Após a confirmação, o novo token será apresentado. Certifique-se de atualizar suas aplicações com esta nova credencial para que a comunicação com a API Omnichannel continue funcionando normalmente. ### Caso de uso Requisição para o endpoint de departamentos :::warning Devemos substituir `“/%7BserverUrl%7D“` por `chat` ::: ```bash curl --request GET \ --url https:///%7BserverUrl%7D.convert.app.br/api/v1/livechat/department \ --header 'Content-Type: application/json' ``` ![](https://s3.us-east-2.amazonaws.com/convert-company-outline/uploads/da620569-2861-4ee9-be7a-ce37f317a1fa/8923929f-b9d2-425a-9da4-3ee6344c0269/image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAWNEQDAE74GWO55AJ%2F20260922%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260922T151500Z&X-Amz-Expires=86400&X-Amz-Signature=30cb44a3e5fee6e44f10762ec2d711bb04bc9b68edd4903f602b6bc20986b25d&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject) --- **1. Método da Requisição (HTTP Method)** * **O que é:** Define a ação que desejamos executar no recurso. Neste caso, `GET` é utilizado para **consultar ou obter dados**, sem alterá-los. Outros métodos comuns são `POST` (criar), `PUT` (atualizar) e `DELETE` (remover). **2. Endpoint (URL da Requisição)** * **O que é:** É o "endereço" específico do recurso que queremos acessar na API. Ele indica exatamente quais dados estamos solicitando. No exemplo, estamos acessando o recurso `livechat/department` para obter a lista de departamentos. **3. Cabeçalho de Autorização (Authorization Header)** * **O que é:** Uma parte dos "cabeçalhos" (headers) da requisição, usada para enviar as credenciais de autenticação. É aqui que informamos a chave da API (neste caso, um `Bearer Token`) que prova que temos permissão para fazer essa solicitação. **4. Corpo da Resposta (Response Body)** * **O que é:** São os dados que a API retorna após a nossa requisição ser processada com sucesso. O formato comum para esses dados é o **JSON**, como mostrado na imagem, que organiza a informação de forma estruturada e legível para sistemas. --- Para consultar os departamentos, nós executamos uma requisição usando o método **(1) GET** no endpoint específico **(2) /livechat/department**. Para garantir o acesso seguro, enviamos nossa chave de autenticação no cabeçalho de autorização **(3)**. Como resultado, a API nos devolveu os dados dos departamentos no corpo da resposta **(4)**. --- **Documents** - [Manuais de produtos](https://docs.convert.app.br/s/7287dde1-b04f-4cad-9d2b-72f5c721e7d1/doc/manuais-de-produtos-9Zwzl1ufq8) - [Treinamentos em vídeo](https://docs.convert.app.br/s/7287dde1-b04f-4cad-9d2b-72f5c721e7d1/doc/treinamentos-em-video-RtQVBvFmgW) - [Versões de produtos](https://docs.convert.app.br/s/7287dde1-b04f-4cad-9d2b-72f5c721e7d1/doc/versoes-de-produtos-TH4Y8GFXxO)