docs

Como utilizar API’s REST via IDR

Hoje é possível realizar a integração de qualquer API REST em sua IDR. Para iniciar, na etapa de seu fluxo em que se fizer necessário este tipo de integração, utilize a ação ‘API – CHAMADA EXTERNA’:

Ao escolher o destino ‘REST:API’ serão exibidas as opções para configuração do método desejado:

  • URL: insira a URL do método.
  • Método: selecione entre as opções o método de sua API.
  • Header: insira os campos necessários, podendo adicionar novos campos clicando no sinal de ‘+’.
  • Body: insira o corpo de sua requisição.
  • Timeout: insira em segundos o tempo desejado para timeout (máx. 60 segundos).
  • Adicionar na chamada parâmetros GET com dados do contato: caso necessário, a Invenio pode concatenar na URL do método os dados do contato (nome, telefone, mensagem, código identificador…).
  • Chamar de forma assíncrona: utilize esta opção para situações em que o fluxo poderá caminhar sem o retorno imediato da chamada, desta forma, é possível configurar as variáveis que receberão o retorno para posterior utilização.

Após inserir a ação de chamada externa, é possível recuperar seu retorno utilizando as variáveis:

  • {{lastapiresponse}}: devolve o retorno exato da requisição.
  • {{lastapistatuscode}}: devolve apenas o código de status da requisição.

Como trabalhar com o retorno de sua requisição #

Conforme vimos acima, utilizando {{lastapiresponse}} é possível recuperar todo retorno da chamada efetuada. Entretanto, para algumas situações, faz-se necessário utilizar apenas parte deste retorno.

Para isto utilize os conceitos de jsonpath para mencionar as variáveis desejadas em uma mensagem ou mesmo criar uma variável com o conteúdo:

Exemplo de mensagem utilizando conceitos jsonpath
Exemplo de variável criada utilizando conceitos jsonpath