Rest API

Olá tripulante 👩🏻‍🚀🚀!! Nesse artigo vamos falar sobre a etapa de Rest Api e como você pode configurá-la dentro do seu bot.

A etapa de Rest Api possibilita que durante a execução do fluxo da conversa você tenha a opção de fazer chamada de qualquer API, basta definir o Método a ser usado, a Url da API e, se preferir, os Parâmetros e Tipo de Parâmetros a serem enviados.

Vou te mostrar o passo a passo de como utilizá-la.

Vamos lá!!

1- Para criar uma etapa de Rest API, dentro do fluxo em que você quer inseri-la, clique no botão de Rest API:

2- Dê um nome à sua API:

3- Caso você vá utilizar a mesma API, com o mesmo método mais de uma vez, é possível cadastrar modelos em Configurações:

4- Escolha o método da sua API:

OBS#: Cada um dos métodos tem uma finalidade, sendo elas:

GET: Aqui, você consegue consultar dados da sua API

POST: Aqui, você consegue enviar dados para sua API

PUT: Aqui, você consegue editar dados na sua API

DELETE: E aqui, você consegue deletar dados na sua API.

5- Em URL, insira a URL/endereço da sua API:

6- Selecione o tipo de parâmetro que você vai utilizar na sua API:

OBS#: Caso você esteja utilizando uma API com método de envio e precise enviar dados do Body, utilize a opção avançado. Será aberto um campo para você inserir os dados do seu Body e Headers:

OBS#: Para que funcione corretamente, é necessário que você atribua os parâmetros em JSON a variável: request__x, os headers em JSON para a variável: headers__x e o body em JSON a variável: body__x, conforme exemplo:

request__x={
"key":"xyz"
};
body__x={
"requests":[
{
"image":{
"source":{
"imageUri": "https://s3.amazonaws.com/asdasd.jpg"
}
},
"features":[
{
"type":"TEXT_DETECTION",
"maxResults":1
}
]
}
]
}

7- Caso não esteja utilizando API's que precisam de envio do Body, em Headers, você consegue inserir os dados do Header da sua API:

8- Em parâmetros você envia os parâmetros da sua API:

9- E para pegar os retornos, em Retornos, utilize response__X:

OBS#: Caso queira acessar os dados em Arrays da sua API, [número da posição]