A caixa REST é utilizada para o fluxo realizar uma requisição externa ao sistema, por meio de uma url predefinida. Ao chegar nela, o fluxo executa uma requisição com as informações providenciadas. Diferente da caixa de requisição Webhook, ela "observa" a requisição e aguarda por uma resposta. O usuário pode optar por executar um script após receber uma resposta, ou armazenar os dados em uma variável, para processamento futuro.
Campos próprios da caixa
- Url de destino
A url que será chamada quando o fluxo estiver na caixa do REST. Será feita uma requisição externa ao link. - Método da requisição
Campo com o tipo de método REST que será executado. Atualmente o sistema suporta GET, POST, DELETE, PUT. - Cabeçalho da requisição
Nesse campo, serão adicionados os cabeçalhos (headers) da requisição REST. - Corpo da requisição
Nesse campo, deve-se informar o conteúdo que será enviado junto com a requisição, seguindo o padrão REST. - Script a executar após a requisição
Caso o usuário opte por executar um script, será possível realizar a execução de um código, seguindo os padrões da caixa de execução de código do sistema. Para acessar os dados da resposta, basta utilizar a variável "restResponse" diretamente. Ela é gerada automaticamente e contém a resposta da requisição. Ela contém dois parâmetros: "responseCode" (inteiro), com o valor de código REST que foi retornado, e o campo "data", um texto com o retorno direto, sem nenhum pre-processamento.
Se o usuário optar por armazenar resposta, esse campo é omitido. No lugar, deve-se preencher o campo "Nome da variável de armazenamento da resposta", onde o valor da variável "restResponse" será armazenado, para uso futuro.