--- title: Integrações – Documentações description: "[INTEGRAÇÕES- DOCUMENTAÇÃO](https://www.youtube.com/embed/Noioa9ARycQ?feature=oembed) # Como acessar e utilizar a Documentação de API da SM Click ## Objetivo Este tutorial apresenta como acessar a **Documentação de API da SM Click**, gerar a chave necessária para autenticação e localizar algumas das informações utilizadas…" url: "https://docs.smclick.com.br/docs/integracoes-documentacoes/" updated: "2026-09-24" category: Integrações --- # Integrações – Documentações [INTEGRAÇÕES- DOCUMENTAÇÃO](https://www.youtube.com/embed/Noioa9ARycQ?feature=oembed) # Como acessar e utilizar a Documentação de API da SM Click ## Objetivo Este tutorial apresenta como acessar a **Documentação de API da SM Click**, gerar a chave necessária para autenticação e localizar algumas das informações utilizadas nas integrações, como: - Token da instância; - ID do departamento; - ID do atendente. A documentação disponibiliza endpoints que podem ser utilizados para executar diferentes ações na plataforma por meio de integrações. --- # 1. Acesse a Documentação de API Para localizar a documentação: 1. Acesse a SM Click utilizando o **perfil gerencial**; 2. No menu lateral esquerdo, clique em **Integrações**; 3. Acesse **Documentação de API**. Nessa área, você terá acesso à documentação disponível para realizar integrações com a plataforma. --- # 2. Gere sua PK de autenticação Para utilizar a documentação e autenticar suas requisições, é necessário gerar uma **PK**. Essa chave é composta por uma combinação de letras e números e é utilizada na autenticação das integrações. > ⚠️ **Importante** > > > > A PK é exibida no momento da geração e deve ser armazenada com segurança. > > > > Caso uma nova PK seja gerada, a chave anterior será desconsiderada. Por isso, mantenha essa informação protegida e disponível apenas para as pessoas responsáveis pelas integrações. --- # 3. Abra a documentação Depois de acessar a área correspondente, clique na opção de **Documentação**. A plataforma abrirá a documentação completa da API da SM Click. Nela, você poderá consultar: - Como realizar a autenticação; - Endpoints disponíveis; - Métodos utilizados; - Informações necessárias para cada requisição. --- # 4. Utilize a documentação em ferramentas como Postman A documentação também pode ser utilizada para realizar testes em ferramentas destinadas a requisições de API, como o **Postman**. Depois de configurar a autenticação, você poderá testar os endpoints disponíveis antes de utilizá-los em uma integração definitiva. --- # 5. Consulte os endpoints disponíveis Na documentação, os endpoints são apresentados juntamente com os respectivos métodos. Entre os métodos apresentados no treinamento estão: - GET; - POST; - DELETE; - Outros métodos disponíveis conforme cada operação. Cada endpoint representa uma ação que pode ser realizada por meio da API. --- # 6. Identifique os dados necessários para cada endpoint Algumas ações exigem informações específicas da sua conta. Por exemplo, para realizar determinadas operações relacionadas à criação de um chat, podem ser necessários dados como: - ID da instância; - ID do departamento; - ID do atendente. Essas informações são geradas pela própria SM Click e podem ser localizadas no perfil gerencial. --- # 7. Localize o token da instância Para consultar a informação relacionada à instância: 1. Acesse o **perfil gerencial**; 2. Entre na área **Home**; 3. Localize a opção de **Tokens de Acesso**; 4. Selecione a instância que deseja utilizar. O token exibido estará relacionado à instância selecionada e poderá ser utilizado conforme solicitado pela integração. > ⚠️ **Importante** > > > > Sempre confirme qual instância deseja utilizar antes de copiar o token, principalmente quando houver mais de uma instância cadastrada. --- # 8. Localize o ID do departamento Todo departamento criado na SM Click possui um identificador próprio. Para localizar: 1. Acesse a área de **Departamentos** no perfil gerencial; 2. Localize o departamento desejado; 3. Clique para **Editar**; 4. Procure pelo **ID** apresentado na tela. Copie essa informação para utilizá-la na integração quando necessário. --- # 9. Localize o ID do atendente Assim como os departamentos, cada atendente criado na plataforma também possui um ID. Para consultar: 1. Acesse o **perfil gerencial**; 2. Entre na área de **Atendentes**; 3. Localize o atendente desejado; 4. Clique em **Editar**; 5. Consulte o ID apresentado na tela. Esse identificador pode ser solicitado em endpoints que precisam direcionar uma ação para um atendente específico. --- # Exemplo de informações utilizadas em uma integração Dependendo do endpoint, sua integração pode precisar reunir informações como: **Instância** Token ou identificação da instância utilizada. ↓ **Departamento** ID do departamento para onde o atendimento será direcionado. ↓ **Atendente** ID do profissional que participará daquela operação. Com essas informações, é possível preencher os parâmetros solicitados pela documentação. --- # 10. Consulte os detalhes de cada endpoint Antes de realizar uma requisição, consulte atentamente a documentação correspondente ao endpoint. Verifique: - Método utilizado; - Autenticação necessária; - Parâmetros solicitados; - IDs necessários; - Dados que precisam ser enviados. A estrutura pode variar conforme a ação que deseja executar. --- # 11. Proteja suas credenciais de integração A PK e os demais tokens utilizados na API dão acesso às integrações da sua operação. Por isso: - Não compartilhe essas informações publicamente; - Restrinja o acesso às pessoas responsáveis; - Armazene as credenciais em local seguro; - Caso gere uma nova PK, lembre-se de que a anterior deixará de ser considerada. --- # Resumo do processo Para acessar e utilizar a Documentação de API: **1. Acesse o perfil gerencial** ↓ **2. Entre em Integrações** ↓ **3. Clique em Documentação de API** ↓ **4. Gere sua PK** ↓ **5. Armazene a chave com segurança** ↓ **6. Abra a documentação** ↓ **7. Localize o endpoint desejado** ↓ **8. Verifique os parâmetros necessários** ↓ **9. Consulte o token da instância, quando necessário** ↓ **10. Consulte o ID do departamento** ↓ **11. Consulte o ID do atendente** ↓ **12. Utilize as informações na sua integração** --- # Onde localizar cada informação ## Documentação da API **Integrações → Documentação de API** ## Token da instância **Perfil Gerencial → Home → Tokens de Acesso** ## ID do departamento **Departamentos → Editar departamento → ID** ## ID do atendente **Atendentes → Editar atendente → ID** --- # Precisa de ajuda? Caso tenha dúvidas sobre a utilização da documentação, possibilidades de integração ou desenvolvimento de uma integração com a SM Click, entre em contato com o **suporte da SM Click**. A plataforma também possui uma equipe responsável por integrações que pode auxiliar na análise das possibilidades disponíveis para sua operação.