API de Terceiros
O nosso assistente virtual Helper disponibiliza uma área para integrar API externas ao chatbot. Com isso você poderá utilizar API de terceiros com todos os recursos do Helper. Essa integração é realizada através de requisição REST e necessita de alguns passos para ser configurada.
Procedimento
- Após acessar a plataforma, acesse o menu "APIs de terceiros";
- A tela apresentará as APIs já cadastrados anteriormente, caso haja algum, com as opções de Edição e Exclusão;
- Caso queira procurar por uma API específica, utilize o campo de busca e clique o botão "Buscar";
- Para registrar uma nova API, clique em "Novo". Aparecerão os seguintes campos para serem preenchidos:
Campo | Definição |
|---|---|
Nome | Definir o nome característico da API que está sendo registrada. |
Dependência | Se necessário, identificar se essa API que está sendo criado necessita anteriormente da execução de uma outra API. |
Método | Selecionar qual método http será utilizado pela API: POST, GET, PUT, DELETE ou PATCH. |
URL | Definir a URL do novo API. Caso queira incluir na URL um contexto já cadastrado no assistente virtual, colocar o valor entre {}. |
Uma vez preenchidos os campos de identificação, vamos preencher os atributos necessários para dar continuidade as requisições REST: cabeçalho, corpo, respostas e configurações.
Cabeçalhos
Essa função permite adicionar valores necessários para o cabeçalho da requisição REST.
- Clique o botão “+” para adicionar o cabeçalho com as informações para:
- Chave;
- Valor;
- Clique em "Salvar".
Corpo
No corpo é possível montar o conteúdo que será enviado no corpo da requisição.
- Clicar o botão “+” para adicionar o corpo com as informações de:
2. Clique em "Salvar".
Respostas
Em respostas, vamos configurar o que a gente espera dessa API.
- Clicar o botão “+” para adicionar as informações para:
- Formato da resposta: pode ser em JSON ou Text;
- Nome;
- Tipo: texto, número, booleano, lista, objeto ou contexto;
- Identificação.
- Clique em "Salvar".
Configurações
Aqui iremos definir as configurações da requisição que irão influenciar no entendimento do assistente.
- Selecione o código desejado para definir os campos:
- Status htpp de sucesso;
- Status htpp de não autorizado;
- Status htpp de não encontrado.
- *As opções apresentadas para esses campos são pré-definidas pelo sistema.
- Depois, definir as mensagens que aparecerão na tela do chatbot para os seguintes casos:
- Mensagem do chatbot para conteúdo não encontrado;
- Mensagem do chatbot para falha na requisição;
- Definir se a API sendo criada é uma API de autenticação.
- Clique em "Salvar".