Rest API Connector

O Rest API Connector é um step que se conecta a aplicativos de terceiros realizando chamadas para os endpoints correspondentes por meio dos métodos HTTP.

Apenas dois de nossos conectores de negócio não são do tipo Rest API.
Para entender melhor a diferença entre os tipos, acesse as páginas MySQL e SAP BAPI.

Adicionando o connector ao canvas

  1. Clique no ícone icone hub com sinal de mais, no menu de edição à esquerda.

  2. Selecione o connector que deseja. Você pode usar a barra de pesquisa search steps icon para encontrá-lo.

  3. Clique no ícone de edição icone lapis para configurar seu formulário.

Cada connector permite apenas uma conexão com o step anterior e uma conexão com o step posterior.

Para copiar o step, clique no botão icone de copiar. Se o formulário do step já estiver configurado, as configurações são copiadas também.

Para excluir o connector do canvas, selecione-o e clique no botão icone lixeira.

Configurando o formulário

A seguir, acompanhe as seções do formulário do Rest API Connector e aprenda a configurá-las:


Information e Requirements

Estas duas seções contam com os seguintes campos e botões:

  • Name: nome do step conector. Campo editável.

  • Connector: campo bloqueado que apenas identifica o connector.

  • Route: selecione o método HTTP e o path que o step conector utilizará. Você também pode digitar o método HTTP ou o path para filtrar os resultados.

  • URL: insira a URL que fará a requisição.

  • Request Timeout: insira o timeout da requisição em milissegundos. Por padrão, o valor será de 3000 milissegundos e o valor máximo de 300000 ms.

    Ao clicar no ícone de Properties icone de lista à direita dos campos URL e Request Timeout, você pode:
    a. Filtrar e exibir variáveis de ambiente e o payload de steps anteriores (se os steps estiverem conectados) para uso na configuração do formulário.
    b. Criar expressões usando o Expression Builder.
  • Security: habilita automaticamente o tipo de segurança já configurado em Authorizations. Se houver mais de um tipo de segurança cadastrado, o campo mostrará uma lista com as opções. Caso o connector não tenha nenhum tipo de segurança habilitado, por padrão o campo exibirá a opção No Auth.

  • Ignore Errors: por padrão, este botão é desabilitado e você pode habilitá-lo. Confira mais detalhes sobre a função do Ignore Errors na tabela abaixo:

    Habilitado switch

    Desabilitado switch off

    A execução do fluxo continua, mesmo que haja erros no processo.

    A execução será interrompida imediatamente.

    Os logs apresentam o step com erro.

    Os logs mostram a execução até o step com erro.

    Steps seguintes serão executados.

    Nenhum step seguinte será executado.

    connector form



Body

Para configurar seu payload usando a aba Body, você tem duas opções:

body connector


Data Mapping

Com o Data Mapping, você pode mapear seu dados manualmente, escolhendo quais deseja mapear e transformar.

Para isso, siga as etapas abaixo:

  1. Clique em + CREATE DATA MAPPING.

    Após clicar no botão, uma nova tela se abrirá:

    dataMapping
  2. Em FROM, selecione um ou mais atributos para mapear e transformar. Ex: "First_name" e "Last_name". Esta seção mostra os dados dos steps anteriores e as variáveis de ambiente.

  3. Em TO, selecione apenas um atributo. Ex: "Name". Na imagem acima, os atributos "First_name" e "Last_name" serão transformados em "Name". Esta seção mostra as propriedades relacionadas ao body do connector.

  4. Em EXPRESSION, você vê os atributos selecionados nas colunas FROM e TO. Caso você queira criar a expressão manualmente, insira os atributos de entrada ou crie uma expressão clicando no botão botao fx à direita. Apenas a função Concat está disponível no momento e não há limite de caracteres.

  5. Clique no botão ADD MAPPING para registrar o mapeamento feito.

    Você pode repetir os passos acima quantas vezes for necessário.
  6. Em DATA MAPPING FIELDS, confira o mapeamento de dados. Cada linha apresenta o atributo de entrada (ou a expressão) e o atributo de saída nas respectivas colunas.

    Uma seta cinza entre as colunas FROM/TO indica a ausência de uma expressão.

    Para excluir uma linha, basta selecioná-la e clicar em icone de lixeira à direita do nome da seção.

  7. Clique em CONFIRM para salvar o mapeamento de dados.

Uma vez salvo, será possível visualizá-lo abaixo da aba Body e a opção de edição estará habilitada.


Data Mapping com Full Body

No canto superior direito de Data Mapping, você pode habilitar ou desabilitar o botão FULL BODY. Assim, a requisição do connector é enviada com as propriedades, estruturas e valores na requisição da chamada e você não precisa mapeá-los um a um. Ao habilitar o botão, você automatiza todo o processo de mapeamento de dados.

full body

Para automatizar seu processo, siga as etapas abaixo:

  1. Habilite o FULL BODY.

  2. No campo Input Data, selecione o step para aplicar o mapeamento de dados. O body completo do step selecionado será incluído na requisição do Rest API Connector. Você verá os dados de request e response dos connectors e os dados de request do trigger.

  3. Em Full Data Mapping, visualize o mapeamento feito automaticamente transformando os campos de FROM para os campos de TO.

  4. Clique em CONFIRM para salvar o mapeamento de dados.

Uma vez salvo, será possível visualizá-lo abaixo da aba Body e a opção de edição estará habilitada.



Ao clicar na aba Header, você visualiza os headers da requisição associados à Route escolhida na configuração do formulário Rest API Connector.

Configure os seguintes campos obrigatórios:

  • Name: por padrão, o formulário carrega o nome dos headers automaticamente. Caso não houver nenhum header associado à rota do seu connector, você poderá inseri-lo manualmente.

  • Value: informe o valor do header. Pode ser manualmente ou utilizando o botão icone de expressao para acessar o Expression Builder. Neste caso, você pode criar expressões ou apenas utilizar a coluna Properties para selecionar os atributos e clicar em CONFIRM.

Para adicionar mais valores, clique em icone de sinal de mais.
Para excluir o valor, clique em icone de lixeira.
header connector



Query

Ao clicar na aba Query, você visualiza as queries da requisição associadas à Route escolhida na configuração do formulário Rest API Connector.

Configure os seguintes campos obrigatórios:

  • Name: por padrão, o formulário carrega o nome das queries automaticamente. Caso não houver nenhuma query associada à rota do seu connector, você poderá inseri-la manualmente.

  • Value: informe o valor da query. Pode ser manualmente ou utilizando o botão icone de expressao para acessar o Expression Builder. Neste caso, você pode criar expressões ou apenas utilizar a coluna Properties para selecionar os atributos e clicar em CONFIRM.

Para adicionar mais valores, clique em icone de sinal de mais.
Para excluir o valor, clique em icone de lixeira.
query connector



Path

Ao clicar na aba Path, você visualiza os paths da requisição associados à Route escolhida na configuração do formulário Rest API Connector.

Configure os seguintes campos obrigatórios:

  • Name: por padrão, o formulário carrega o nome dos paths automaticamente. Caso não houver nenhum path associado à rota do seu connector, o campo é bloqueado.

  • Value: informe o valor do path. Pode ser manualmente ou utilizando o botão icone de expressao para acessar o Expression Builder. Neste caso, você pode criar expressões ou apenas utilizar a coluna Properties para selecionar os atributos e clicar em CONFIRM.

path connector

Após finalizar a configuração do step conector, clique em SAVE.

Expression Builder

O componente Expression Builder permite que você crie expressões com parâmetros e variáveis através de funções e condições disponíveis dentro do componente. Assim, você pode ajustar a expressão conforme suas necessidades.

Você pode criar expressões para os seguintes campos:

  • URL;

  • Request Timeout.

Siga os passos abaixo para acessar a tela do Expression Builder:

  1. Clique no ícone de Properties icone de lista, à direita dos campos URL ou Request Timeout.

  2. Em seguida, clique no ícone icone de expressão no canto superior direito.

expression builder connector

A tela de Expression Builder contém as seguintes seções:

  • Properties: mostra os dados dos steps anteriores e as variáveis de ambiente. Você pode filtrar os atributos usando o campo de busca no topo da seção e clicando em icone lupa. Você pode selecionar mais de um atributo. Ao selecioná-lo, o atributo aparece no campo Expression.

  • Expression: campo para inserir os atributos de entrada ou criar uma expressão clicando no botão botao fx à direita. Apenas a função Concat está disponível para criar a expressão.

Ao selecionar dois ou mais atributos no campo Properties, será obrigatória a criação de uma expressão.

Para salvar as informações, clique em CONFIRM.

Alerta alertIcon

Um ícone de alerta aparece no step conector caso os campos abaixo não estejam configurados:

  • Route

  • URL

  • Request Timeout

  • Security

Você também vê o alerta se:
- as variáveis cadastradas em Environment Variables ou
- os atributos cadastrados em steps anteriores
forem alterados ou excluídos enquanto ainda são usados no step configurado.
Thanks for your feedback!
EDIT
How useful was this article to you?