API REST
Criando um conector
Para criar um conector de API REST, siga os passos abaixo:
-
Acesse a tela Connector Manager pelo menu à esquerda ou clicando no cartão na tela Welcome.
-
Clique em + NEW CONNECTOR no canto superior direito da tela.
-
Selecione o cartão REST API.
-
Importe um arquivo com a especificação Open API 3.0.0.
Ao clicar no cartão do conector, aparecerá uma janela modal para importar o arquivo. Clique em SELECT FILE para localizá-lo e depois em IMPORT.
Somente é permitido importar arquivos locais com as seguintes extensões:
-
json
; -
yaml
; -
yml
.
Ao importar o arquivo, o sistema verificará se existem erros de estrutura e se o arquivo está em conformidade com a versão suportada.
Após a validação, a tela de configuração do conector abrirá e os seus campos serão preenchidos automaticamente com os dados importados.
-
-
Se desejar alterar as informações carregadas automaticamente, edite os campos:
-
Name: nome do conector.
-
Version: versão do conector.
-
Description: descrição do conector.
-
Add icon: opção para adicionar um ícone para representar o conector no Flow.
-
-
Selecione os endpoints do arquivo Open API 3.0.0 que deseja utilizar no conector.
Clique em Select All para selecionar todos os endpoints disponíveis.
À direita dos endpoints, você visualizará a requisição (request) e resposta (response) de cada endpoint selecionado. -
Clique em CREATE.
![create rest api connector](_images/create-rest-api-connector.gif)
Não é permitido editar um conector de API REST. |
Configurando um conector
Depois de criar o conector, você deverá configurá-lo na tela Flow. Para isso, siga os passos abaixo:
Adicionando o conector ao canvas
-
Acesse a tela Integration Flows e selecione o seu fluxo de integração.
Se desejar criar um fluxo novo, clique em + NEW FLOW e acesse a tela Flow.Consulte nosso tutorial sobre como criar seu primeiro fluxo de integração. -
Clique no ícone
, no menu de edição à esquerda.
-
Selecione o conector que deseja. Você pode usar a barra de pesquisa
para encontrá-lo.
-
Clique no ícone de edição
para configurar seu formulário.
Cada conector 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 ![]() |
Para excluir o conector do canvas, selecione-o e clique no botão .
Configurando o formulário
A seguir, acompanhe as seções do formulário do conector de API REST 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 conector.
-
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 à 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 conector 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
Desabilitado
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.
Body
Para configurar seu payload usando a aba Body, você tem duas opções:
![body connector](_images/body-connector.png)
Data Mapping
Com o Data Mapping, você pode mapear seu dados manualmente, escolhendo quais deseja mapear e transformar.
Para isso, siga as etapas abaixo:
-
Clique em + CREATE DATA MAPPING.
Após clicar no botão, uma nova tela se abrirá:
-
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.
-
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 conector.
-
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
à direita. Apenas a função Concat está disponível no momento e não há limite de caracteres.
-
Clique no botão ADD MAPPING para registrar o mapeamento feito.
Você pode repetir os passos acima quantas vezes for necessário. -
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
à direita do nome da seção.
-
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 conector é 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.
Para automatizar seu processo, siga as etapas abaixo:
-
Habilite o FULL BODY.
-
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 conector de API REST. Você verá os dados de requisição e resposta dos conectores e os dados de requisição do trigger.
-
Em Full Data Mapping, visualize o mapeamento feito automaticamente transformando os campos de FROM para os campos de TO.
-
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.
Header
Ao clicar na aba Header, você visualiza os headers da requisição associados à Route escolhida na configuração do formulário do conector de API REST.
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 conector, você poderá inseri-lo manualmente.
-
Value: informe o valor do header. Pode ser manualmente ou utilizando o botão
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 ![]() Para excluir o valor, clique em ![]() |
![header connector](_images/header-connector.png)
Query
Ao clicar na aba Query, você visualiza as queries da requisição associadas à Route escolhida na configuração do formulário do conector de API REST.
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 conector, você poderá inseri-la manualmente.
-
Value: informe o valor da query. Pode ser manualmente ou utilizando o botão
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 ![]() Para excluir o valor, clique em ![]() |
![query connector](_images/query-connector.png)
Path
Ao clicar na aba Path, você visualiza os paths da requisição associados à Route escolhida na configuração do formulário do conector de API REST.
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 conector, o campo é bloqueado.
-
Value: informe o valor do path. Pode ser manualmente ou utilizando o botão
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](_images/path-connector.png)
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:
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
. 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
à 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](_images/alertIcon.png)
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. |
Share your suggestions with us!
Click here and then [+ Submit idea]