Pular para o conteúdo principal

Introdução

O módulo "Integrations" permite combinar APIs e serviços online por meio de programação visual. Você arrasta blocos (nós) e os conecta entre si, montando a lógica dos seus aplicativos de forma visual. Isso simplifica o desenvolvimento, que fica acessível até para quem não é programador profissional, e acelera bastante a integração entre sistemas:

Elementos principais da interface do módulo Integrations​

1. Painel esquerdo com nós​

O painel esquerdo reúne todos os nós disponíveis. É com eles que você monta seus fluxos de dados.

Para usar um nó, arraste-o para a área de trabalho. Cada nó tem sua própria função e é configurado individualmente.

Exemplos de nós:

  • Inject: envia dados para o fluxo manualmente.
  • Debug: exibe dados e mensagens no menu de depuração.
  • Function: permite escrever código personalizado em JavaScript.
  • Template: cria modelos de texto ou HTML.

2. Abas​

As abas ficam acima da área de trabalho e permitem alternar entre projetos ou fluxos de dados. Elas ajudam quando você trabalha em várias integrações ao mesmo tempo ou quer dividir a lógica em vários fluxos.

  • Criar abas: clique no botão com o sinal de mais +. Cada nova aba é um fluxo de dados separado, o que ajuda a organizar o projeto.
  • Renomear abas: clique duas vezes no nome da aba e digite o novo nome. Isso é útil principalmente quando há muitas abas e você quer saber com clareza o que há em cada uma.
  • Excluir abas: clique com o botão direito na aba e selecione Delete no menu de contexto. Tenha cuidado para não perder dados importantes.
  • Desativar abas: no mesmo menu de contexto, a opção Disable desativa o fluxo da aba sem excluí-la. Em uma aba desativada, a opção passa a se chamar Enable e reativa o fluxo. No esquema JSON, esse estado fica no campo disabled da aba.

Exemplo: se você estiver trabalhando em uma integração de pagamentos, pode criar uma aba separada para cada serviço.

3. Área de trabalho​

A área de trabalho é a parte central da interface, onde você monta e edita seus fluxos de dados.

  • Posicionar nós: o nó que você arrasta do painel esquerdo aparece na área de trabalho. Ali você pode movê-lo, conectá-lo a outros nós e montar a lógica do fluxo.
  • Conectar nós: arraste uma linha da saída de um nó até a entrada de outro. Assim os dados passam de um nó para o outro ao longo do fluxo.
  • Gerenciar fluxos: na área de trabalho você pode criar vários fluxos de dados, o que ajuda a organizar integrações e lógicas complexas.

Dica: use o mouse ou o touchpad para dar zoom na área de trabalho e ver todos os detalhes do fluxo.

4. Formulário de edição do nó​

Clique duas vezes em um nó na área de trabalho para abrir o formulário de edição do nó, onde você configura o comportamento dele.

  • Campos de configuração: cada nó tem seus próprios parâmetros editáveis. Por exemplo, no nó Function você pode escrever e editar código.
  • Salvar alterações: depois de editar o nó, clique em Submit para salvar as alterações.

Exemplo: no nó Function, você pode escrever código JavaScript que transforma os dados. No nó Template, pode criar um modelo que insere dados dinamicamente.

5. Painel de depuração​

O painel de depuração fica à direita e mostra os dados de saída e as mensagens do nó Debug. Ele tem duas abas: Debug, com as mensagens do fluxo, e Configuration.

  • Ver mensagens: quando você executa o fluxo, o nó Debug envia mensagens para a aba Debug. Assim você vê o que acontece no fluxo e confere se os dados estão corretos.
  • Filtrar mensagens: a lista acima das mensagens define de quais nós elas são exibidas: all nodes mostra as de todos os nós, e current workflow, só as dos nós da aba atual. Isso ajuda quando há muita saída de diferentes nós Debug.
  • Limpar a janela Debug: clique no ícone de X ao lado do filtro para remover as mensagens antigas e se concentrar nos dados novos.

Exemplo: se você usa um nó Function para fazer cálculos, adicione um nó Debug no fim do fluxo para verificar se o código processa os dados corretamente.

6. Botões de controle​

Botão Open full screen​

  • Expande a interface do módulo Integrations para a tela inteira, o que é útil ao trabalhar em fluxos de dados complexos ou ao apresentar o projeto em um monitor grande.
  • Com ele, você ganha mais espaço para edição e vê melhor todos os detalhes dos fluxos.

Botão Publish​

  • É o botão principal: salva e implanta todas as alterações feitas nos fluxos de dados, tornando-as ativas. Depois de adicionar ou modificar nós, não deixe de clicar nele para que suas configurações passem a funcionar.

Botão Import​

Input Schema e passagem do esquema entre nós​

No formulário de edição, cada nó exibe o bloco Input Schema: o esquema dos dados que chegam do nó anterior no fluxo. O esquema mostra os campos disponíveis como pares "chave: tipo", respeitando o aninhamento dos objetos.

Se o campo tiver uma descrição na descrição da API, ela aparece ao lado da chave. O editor de código usa essas mesmas descrições para autocompletar e exibir dicas ao escrever templates Mustache.

Quais nós passam o esquema para o próximo nó​

Nem todos os nós passam o esquema adiante. Estes são os que passam:

  • Function: o esquema é gerado a partir do campo Output Example (JSON). Esse campo também serve como dados de teste quando o fluxo é chamado sem executar de fato o código da Function.
  • Admin API: o esquema vem da descrição do método na descrição da API. Ao clicar em Execute, o esquema é atualizado com a resposta real da API. Os campos que coincidem com a descrição da API mantêm suas descrições em texto.
  • Http Request: no início não há esquema. Ele aparece depois que você clica em Execute e é obtido da resposta real.

Botão Execute​

Os nós Admin API e Http Request têm o botão Execute no formulário de edição. Ele executa toda a cadeia de nós, do início do fluxo até o nó atual.

Particularidades:

  • O servidor executa o fluxo no estado do último Publish. Antes de testar, verifique se o fluxo foi publicado.
  • Se um nó function no caminho não passar dados adiante, mas tiver o Output Example (JSON) preenchido, esse valor é usado como dados de teste.
  • Se a resposta for bem-sucedida, o resultado passa para o próximo nó como esquema.
  • Se houver erro, nenhum esquema passa para o próximo nó.

Chamada automática de nós somente leitura​

Todos os nós admin-api que fazem apenas requisições de leitura (GET) são chamados automaticamente ao abrir a página Integrations e ao atualizar o fluxo pelo botão Publish. Assim o esquema de dados fica sempre atualizado, sem execução manual.

Última atualização a