O que são conectores?

Um conector é responsável por criar a integração entre o seu bot com qualquer sistema que possua uma API do tipo REST.

Porque utilizar um conector?

Fazendo uso de um conector no seu bot, você terá um fluxo de atendimento que oferece ao usuário um autosserviço. Por exemplo:

• Consultar status de um pedido;
• Verificar data de entrega de um pedido;
• Capturar leads;
• Gerar protocolo ou consultar protocolos, entre outras ações.

Como criar um conector?

Para iniciar o procedimento de criação, acesse o bot desejado:

Após acessar o bot, clique na opção "Integrações", localizada no menu inicial do seu bot:

Em Integrações, role a tela até localizar a opção "Criar Conector":

Ao clicar na opção "Criar Conector", um pop-up será aberto para a configuração da integração.

DICA: Utilize o aplicativo Postman, para testar as requisições que serão realizadas na sua API. Após os testes serem concluídos com sucesso, inicie a configuração do seu conector.

Veja abaixo, como inserir os dados da sua API na configuração do conector:

Aba Dados

Defina um nome para o seu conector e escolha se o seu método será: 

• GET - Para consulta de dados;
• POST - Para criação de dados;
• PUT -  Para atualizar um dado já existente;
• DELETE - Para deletar um dado existente.

A escolha do método será de acordo com a operação que você deseja realizar e também seguindo a estrutura que o seu Endpoint possui. Clique em "Salvar e Próximo", para prosseguir com a configuração:

Aba URL

No campo "Endpoint" insira a URL do seu serviço que será acessado para pegar/enviar/alterar/deletar os dados. Por exemplo:

Se no seu Endpoint é necessário realizar passagem de valores via URL, você pode incluir os mesmos nos campos: Nome e Valor. Como no exemplo abaixo:

Após preencher os campos, clique em "Salvar e Próximo", para prosseguir com a configuração:

Aba Headers

Preencha essa aba, caso o seu Endpoint requer o envio de informações via Header.

Basta cadastrar o nome da informação no campo "Nome" e o seu valor no campo "Valor".

Além da inserção de valores, você também pode:

• Modificar a visualização desse valor para privado, selecionando a opção “Valor privado”. Com isso, após a sua criação, o valor ficará como secreto e não poderá mais ser visualizado. Como no exemplo abaixo:

• Adicionar novos valores, clicando na opção ;
• Remover os valores, clique na opção

Após preencher os campos, clique em "Salvar e Próximo", para prosseguir com a configuração:

Aba Autenticação

Preencha essa aba, se o seu Endpoint necessita da passagem de uma autenticação para acesso aos dados.

Através do campo "Autenticação", você poderá escolher o tipo de autenticação que o seu Endpoint utiliza, para a inserção das credenciais:

Após a escolha do tipo de autenticação, basta preencher os campos disponibilizados com as suas credenciais.

Clique em "Salvar e Próximo", para prosseguir com a configuração:

Aba Requisição

Preencha essa aba, caso necessite coletar informações do seu bot e enviar para o seu sistema.

Insira no campo Request JSON, o corpo JSON que possua as variáveis do seu bot que contenha o valor que será enviado ou se preferir defina valores fixos para o envio. Como no exemplo abaixo:

Após preenchimento do campo, clique em "Salvar e Próximo", para prosseguir com a configuração.

Aba Resposta

Nesta aba, é configurado o corpo json da resposta obtida através da requisição do Endpoint. 

• No campo "Index Variável", defina um apelido para as variáveis da integração que você está criando (visando melhor identificação/manipulação das variáveis no fluxo de conversa);
• No campo "Variáveis", insira o corpo json da resposta, possuindo as variáveis que contenha as informações que serão utilizadas no fluxo de conversa do seu bot. Veja o exemplo abaixo, é indicado o nome das variáveis recebidas na resposta da requisição e definida as variáveis do Droz que irão receber estes valores. 

Você também pode formatar os dados recebidos, para tornar a visualização da informação mais amigável ao usuário. Veja abaixo as possíveis formatações:  

• Moeda: Para transformar um valor para o formato em Reais (R$ 0,00) é necessário utilizar a palavra CURRENCY. 

Exemplo: {"total": "${total} |CURRENCY "}   

• De x Para: Para realizar um “De x Para” de informações utilizamos a palavra ENUM. 

Exemplo: {"status": "${status} |ENUM|TRUE=Ativado,FALSE=Desativado "}  

• Data: Para realizar uma formatação de um dado do tipo data, precisamos usar a palavra DATE e informar qual o formato que está vindo pela API e qual o novo formato desejado. 

Exemplos:

{"date": "${date} |DATE|formatTo=dd/MM/yyyy "} 

{"date": "${date} |DATE|formatFrom=yyyy-MM-dd,formatTo=dd/MM/yyyy "}  

ATENÇÃO: Caso a formatação da sua API for ISO, você não precisa utilizar o  formatFrom. 

• Data e Hora: Para realizar uma formatação de um dado do tipo data e hora, precisamos usar a palavra DATE_TIME e informar qual o formato que está vindo pela API e qual o novo formato desejado. 

Exemplos:

{"dateTime": "${dateTime} |DATE_TIME|formatTo=dd/MM/yyyy HH:mm:ss "} 

{"dateTime": "${dateTime} |DATE_TIME|formatFrom=yyyy-MM-dd HH:mm:ss,formatTo=dd/MM/yyyy HH:mm:ss "}   

ATENÇÃO: Caso a formatação da sua API for ISO, você não precisa utilizar o  formatFrom. 

• Regex: Com o regex é possível extrair informações específicas de um texto.

Exemplo: {"value": "${value} |REGEX|[0-9] "} 

Após preencher os campos, clique em "Salvar e Próximo", para prosseguir com a configuração.

Aba Timeout

Determine por quanto tempo (em milisegundos) o bot ficará aguardando pela resposta da requisição realizada.

Após, clique em "Salvar" para concluir a configuração da integração.

Saiba como fazer uso dos dados recebidos da sua API, no fluxo de conversa do seu bot, clicando aqui.