Entenda como funciona a integração com o Fluxo de Bots da SM Click.
Funcionamento #
A integração com o Fluxo de Bots oferecerá a você a capacidade de criar diversas formas de integração. Isso inclui a criação de leads em um sistema CRM, o cadastro de clientes em sistemas externos, consulta de segunda via de boletos, entre outras possibilidades. Você terá autonomia para conceber, administrar e modificar as integrações com sistemas externos diretamente no fluxo do bot.
Requisitos #
Para criar uma integração com o Fluxo de Bots é necessário que você tenha pelo menos uma instância na SM Click. É por meio dessa instância que você ativará seu fluxo de bot, garantindo sua prontidão para atender os clientes de maneira automática e seguir o curso da integração. Lembrando que a instância fica disponível no plano Gamma ou adquirindo-a separadamente no gerenciamento da assinatura.
É importante verificar se o sistema que pretende integrar com a SM Click possui API Rest. Feito isso é importante também entender o fluxo de integração e fluxo de informações que precisa gerar através da integração.
Entender sobre APIs (Interfaces de Programação de Aplicações) é essencial para conseguir desenvolver a integração e pode envolver alguns conhecimentos básicos. Aqui estão alguns conceitos fundamentais:
- O que é uma API:
- API, ou Interface de Programação de Aplicações, é um conjunto de regras e definições que permite que diferentes softwares se comuniquem entre si.
- HTTP/HTTPS:
- Compreender os protocolos de comunicação, como HTTP (Hypertext Transfer Protocol) e HTTPS (HTTP Secure), que são comuns para a interação entre sistemas via web.
- Métodos HTTP:
- Conhecer os métodos HTTP, como GET (obter informações), POST (enviar informações), PUT (atualizar informações) e DELETE (excluir informações), que são utilizados para realizar operações sobre os recursos.
- Autenticação:
- Entender como a autenticação funciona, seja por meio de chaves de API, tokens ou outros métodos, para garantir a segurança nas interações. No caso da integração com a SM Click irá funcionar apenas para autenticações OAuth (Open Authorization), para integrações onde o método de autenticação for OAuth 2.0 por favor, entrar em contato com nossa equipe de Tecnologia para verificar a viabilidade da integração.
- Formato de Dados (JSON):
- Familiaridade com formatos de dados como JSON (JavaScript Object Notation) frequentemente utilizado para estruturar e transmitir informações entre sistemas.
- Endpoints:
- Compreender o conceito de endpoints, que são URLs específicas que representam diferentes funcionalidades ou recursos disponíveis na API.
- Status Codes:
- Conhecer os códigos de status HTTP, como 200 (OK), 404 (Not Found) e 500 (Internal Server Error), para entender o resultado das requisições.
- Documentação da API:
- Saber como ler e entender a documentação da API, que fornece informações detalhadas sobre como usar os endpoints, os parâmetros necessários, e exemplos de requisições e respostas.
- Teste de API:
- Ter habilidades básicas para testar APIs, utilizando ferramentas como Postman ou curl, para verificar a integração e o correto funcionamento. Neste caso conseguiremos testar a integração durante o processo de criação do fluxo de bots.
- Segurança:
- Conscientização sobre práticas de segurança, como uso de HTTPS, autenticação segura e controle adequado de permissões.
Estes são conhecimentos iniciais que podem ajudar a compreender e interagir com APIs de forma eficaz.
Criar Integração no Fluxo de Bots #
Primeiramente você deverá entender mais sobre a criação do Fluxo de Bots. E também é fundamental compreender as funcionalidades de Informações de Cadastros, pois por meio delas é possível criar formulários para coletar dados dos clientes. Se a intenção for reunir informações para enviar ao seu sistema externo, como nome, e-mail, CPF, CNPJ e endereço, você pode utilizar eficientemente esses recursos de cadastro.
Após configurar o Fluxo de Bots e também as Informações de Cadastros, iremos configurar a integração.
Acesse Atendimentos, em seguida Fluxos de Bots, feito isso você deverá identificar aonde deseja configurar a integração e clicar em Editar Fluxo.
Após realizar este processo, identifique o bloco chamado Integração e arraste-o para o próximo fluxo do seu bot.
Vamos agora configurar os requisitos para a integração. É importante ressaltar que você deve manter a documentação API do sistema de integração sempre acessível. Isso garantirá que você consulte as informações essenciais necessárias para criar uma integração bem-sucedida.
Logo após arrastar o bloco de integrações para seu fluxo de bot, será possível acessar a tela de configuração.
Em Requisição deverá ser fornecido o método HTTP: GET, POST, PATCH, PUT e DELETE
Vamos agora configurar a URL que será feita a chamada da requisição (estamos criando um exemplo a partir de uma integração com o RD Station CRM).
Agora, iremos configurar o Headers da requisição. Neste caso o único parâmetro obrigatório para o exemplo utilizado foi o “Content-Type: application/json“. Você deverá entender os paramêtros obrigatórios através da documentação API do sistema a ser integrado.
Quando utilizamos os métodos HTTP POST, PUT, PATCH e DELETE, pode-se enviar o Body (payload/corpo da solicitação) na requisição.
Neste ponto é importante citar que para criar a integração você deverá obter o JSON do sistema que deseja integrar, utilizamos como base o método de Criar Negociação do Rd Station como exemplo.
Para aninhar o valor de “name” dentro de “deal“, você deverá criar a Chave “deal[name]” em seguida digitar o valor que deseja atribuir. Agora quando precisamos aninhar um array dentro de uma lista, vamos utilizar o exemplo de “name” em “contacts“, a Chave ficará da seguinte forma, “contacts[0][name]“, onde [0] aponta a posição do valor no array.
Nos campos de valores das chaves, você poderá definir para trazer os dados referente as Informações de Cadastros (Campos de Segmentação), basta clicar em Trocar de campo de segmentação para texto em seguida Selecione um campo.
Agora é só escolher dentre os campos de segmentações criados em Informações de Cadastros. Neste exemplo iremos substituir o nome do lead pelo nome do cliente que foi digitado nas etapas do Fluxo de Bots.
Após realizar as configurações, você poderá visualizar o JSON formado através das Chaves e Valores.
Está etapa é importante para que você compare o JSON padrão do sistema que deseja integrar com o criado através das Chaves e Valores. Se estiverem iguais poderá realizar o teste clicando em Testar
Realizado o teste, no lado direito da tela irá aparecer o Response da sua requisição, com as seguintes informações: Status Code, Headers (resposta) e o Body (resposta).
É possível configurar para que seja enviado uma mensagem ao seu cliente após a integração ter ocorrido. Para isso iremos utilizar um exemplo de integração onde o response deverá conter um boleto.
Neste exemplo, identificamos no Body (response) que o valor onde se encontra a URL do boleto fica na chave url dentro de data, então para construir a mensagem e enviar o link de pagamento durante a integração, você deverá construir da seguinte estrutura na mensagem {data[url]}. Feito isso a mensagem será enviada contendo o link do boleto.
Após concluir a configuração da integração, será possível incluir diversas opções, como um Atendimento para direcionar seu cliente a um departamento específico. Além disso, é possível optar por receber somente uma Informação ou adicionar uma Pergunta ao processo.
Organize o desenvolvimento do seu processo de integração seguindo o fluxo designado. Certifique-se de examinar minuciosamente a documentação da API do sistema em questão e elabore sua integração de maneira a automatizar tarefas recorrentes, contribuindo significativamente para otimizar o processo de atendimento.
