API

Owned by Vinicius Fiorio Custodio
Last updated: mar. 19, 2024
3 min read
image-20240308-044126.png

 

Uso geral

Utilizado para acionar um webservice externo, deve ser usado sempre que uma decisão ou conjunto de opções a ser retornado precise de ser dinâmico e/ou baseado em um serviço externo.

Este nó pode se mostrar complexo e ter retornos de erro mais diversos

 

Criação do nó de API

image-20240319-211348.png

Para criar o nó de API preencha os campos conforme a imagem:

  1. Título do nó - Exibido no construtor de fluxo e serve como identificação no fluxo;

  2. Descrição - Descrição interna do nó, utilize para exemplificar o uso;

  3. Método - Escolha o verbo http esperado por sua API, os tipos esperados são: GET, POST, PUT e DELETE

  4. URL - A url a ser acionada pelo fluxo, deve conter todo a URL qualificada incluindo o protocolo “http”

  5. Adicionar Header - Caso sua API espere qualquer header, ele pode ser adicionado através desse campo, lembando que qualquer variável pode ser adicionada nos valores do header;

  6. Header Nome [*] - Indique o nome do header a ser enviado na requisição, vários headers podem ser cadastrados por requisição

  7. Header Valor [*] - Indique o valor do header a ser enviado na requisição, assim como o seu par, vários headers podem ser enviados

  8. Body - informe o body a ser enviado como RAW na requisição, é suportado qualquer variável no formato JSON ;

  9. Variáveis - informe um nome único para a variável que irá armazenar o body retornado pela API, o retorno suportado pelo construtor de fluxo é em JSON, posteriomente um JSON pode ser convertido em um objeto e suas propriedades acessadas livremente;

 

Pontos de entrada e saída

 

 

 

O nó de Fila possui os seguintes pontos conforme a imagem:

  1. Ponto de entrada

  2. Ponto de saída - Default - quando uma requisição à API mencionada acontece com sucesso, retornando Http Status Code 200

  3. Ponto de saída - Erro - Sempre que um http status code retornado é diferente de 200 ou um erro de timeout é retornado

    1. Para capturar erros você pode conectar um nó de mensagem enquanto monta o seu fluxo, e adicionar uma mensagem como: Erro API {{ nomeVar | dump | safe }}

 

Aparência

Acesso à API não traz nenhum retorno visual para o usuário, a API é executada e o fluxo segue, a exibição de uma mensagem de sucesso ou erro fica a cargo do contexto.

Pré-requisitos

  1. A API deve estar acessível via internet, ou acessível da whitelist do IP Fixo do Mosia Omnichannel;

  2. Deve ser compatível com algum dos métodos suportados: : GET, POST, PUT ou DELETE

  3. Deve responder antes do timeout do fluxo (15 segundos)

  4. Caso queria capturar o retorno para o uso posterior como uma variável, o body retornado deve ser no formato JSON;

 

Recomendamos fortemente o uso do protocolo http seguro https://

 

Mobile Saúde - Mosia Omnichannel