Operações de Módulos

PreviousGestão das contas conectadas NextImportar operações em módulos REST

Last updated 6 months ago

Operações de Módulos

"Operações" são chamadas atômicas de APIs, atreladas a um módulo, que encapsulam a execução de uma função previamente configurada. Ou seja, as operações são as ações que poderão ser realizadas por seu módulo quando adicionadas, posteriormente, a um fluxo.

Exemplo: imagine que temos um módulo chamado “VendasY” e ele pode realizar as seguintes operações:

Listar todas as vendas do dia
Listar os 10 produtos mais vendidos
Adicionar um produto e seu respectivo preço

Todos esses exemplos são configuráveis através das operações.

Sem uma operação, não há como utilizar um módulo em seus fluxos.

Como adicionar uma operação

Clique em "Nova operação".

Em seguida, será mostra a tela para o preenchimento dos dados da nova operação, sendo que ela é dividida em 4 etapas:

Acompanhe passo a passo cada item:

Informações Gerais

Adicione o nome e a descrição da nova operação.
Em seguida, clique em "Próximo Passo".

Parâmetros

Nesta etapa você irá configurar o parâmetro que será utilizado no módulo, sempre de acordo com o tipo (Banco de Dados, E-mail, REST, etc). Para isso:

Clique em "Adicionar parâmetro". Em seguida será mostrado o seguinte modal:

Sendo que os campos:

Nome: escolha um nome que melhor descreva a função do parâmetro;
Descrição: descreva a função do parâmetro;
Tipo: selecione aqui o tipo de dados aceito pelo parâmetro:
- Texto: qualquer combinação de caracteres alfanuméricos. Exemplos: "qualquertexto", "123"
- Número: qualquer número. Exemplos: 123, 321, etc.
- Booleano: true/false (verdadeiro/falso)
- Objeto: objeto JSON. Exemplo: { “name” : “John” }
- Array: array JSON. Exemplos: [ “A”, “B” ], [ “1”, “2” ]
Campo obrigatório: torna o parâmetro obrigatório quando marcada, fazendo com que ele sempre seja passado no JSON de entrada.
Dado sensível: quando selecionado, este campo denota que o valor do parâmetro não será publicado caso o módulo seja compartilhado.
Exemplo: adicione um exemplo de acordo com o tipo de dado especificado no campo "Tipo" e considerando o tipo de conectividade do módulo (Banco de dados, Email, etc) . Por exemplo:
1. Banco de Dados: utilize exemplos usando os comandos SQL válidos (SELECT, UPDATE, DELETE, etc).
2. REST: use as operações GET, POST, PUT, DELETE e PATCH.
Para finalizar, clique em "Salvar informações".

Não há limite no número de parâmetros que podem ser criados, mas recomendamos que a nomenclatura e descrição sejam feitas de forma estruturada, para facilitar a identificação e uso.

Requisição

Nesta aba, você poderá escrever uma requisição usando os parâmetros criados anteriormente. Para facilitar, organizamos as orientações por tipo de conectividade. Clique na opção adequada:

Banco de Dados

Em módulos do tipo Banco de Dados, a área de requisição contém o campo "Query" e os parâmetros disponíveis, que podem ser arrastados para dentro do campo "Query". Se preferir, é possível adicionar outros parâmetros diretamente na Query.

Em módulos do tipo Email, a área de requisição contém os seguintes campos:

Parâmetros disponíveis: lista dos parâmetros criados previamente;
Destinatário: arraste o parâmetro correspondente para este campo;
Assunto: arraste o parâmetro correspondente para este campo;
Body: além do parâmetro criado previamente, este campo requer um código HTML, como o exemplo abaixo:

REST

Em módulos do tipo REST, a área de requisição contém os seguintes campos:

Parâmetros disponíveis: lista dos parâmetros criados previamente;
Método: selecione o método HTTP a ser utilizado na requisição. As opções disponíveis são:
- GET: Usado para recuperar dados.
- POST: Enviar dados ou criar novos recursos.
- PUT: Atualizar recursos de forma completa.
- DELETE: Excluir recursos.
- PATCH: Atualizar recursos parcialmente.
URL (não obrigatório): escolha o formato da URL que será utilizada na requisição:
- PATH: Caminho relativo, utilizado quando a URL base já está definida em outro local.
- FULL URL: Endereço completo, útil para requisições fora do domínio
Endpoint: digite ou cole o caminho que será chamado para realizar a requisição.
Body: caso o método escolhido aceite um body (como POST, PUT ou PATCH), insira os dados que serão enviados. O corpo da requisição pode estar em formatos como JSON, XML, ou outros conforme a API.
Header: defina os cabeçalhos HTTP que devem ser incluídos na requisição, como Content-Type, Authorization, ou outros conforme a necessidade do serviço que está sendo integrado.
Query: insira os parâmetros de consulta (query parameters) que serão anexados à URL. Esses parâmetros geralmente são usados para filtrar, ordenar ou paginar os dados na requisição.

SOAP

Em módulos do tipo SOAP, a área de requisição contém os seguintes campos:

Parâmetros disponíveis: lista dos parâmetros criados previamente;
Body: o corpo da requisição SOAP deve seguir o padrão XML. No body, é necessário incluir os parâmetros que correspondem à operação solicitada ao serviço SOAP.
Header: os headers podem incluir informações de autenticação, como tokens, ou dados de controle da transação.

Arquivo

Em módulos do tipo Arquivo, a área de requisição contém os seguintes campos:

Parâmetros disponíveis: lista dos parâmetros criados previamente;
Tipo de operação: as opções disponíveis são:
- Mover um arquivo: ao escolher esta opção, a tela mostra os seguintes campos:
  - Caminho: especifique o caminho do diretório onde o arqui está atualmente
  - Nome: insira o nome do arquivo que será movido.
  - Caminho para: informe o novo caminho para onde o arquivo será movido.
- Apagar um arquivo: ao escolher esta opção, a tela mostra os seguintes campos:
  - Caminho: especifique o caminho do diretório onde o arquivo a ser apagado está localizado.
  - Nome: insira o nome do arquivo que será apagado.
- Salvar arquivo: ao escolher esta opção, a tela mostra os seguintes campos:
  - Caminho: informe o caminho do diretório onde o arquivo será salvo.
  - Nome: insira o nome do arquivo que será salvo
  - Conteúdo: especifique o conteúdo que será salvo no arquivo.
  - Acrescentar o conteúdo se houver um arquivo com o mesmo nome: marque esta opção se desejar acrescentar o novo conteúdo ao arquivo existente, em vez de sobrescrevê-lo.
- Ler um arquivo: ao escolher esta opção, a tela mostra os seguintes campos:
  - Caminho: especifique o caminho do diretório onde o arquivo está localizado.
  - Nome: insira o nome do arquivo que será lido.
  - Formato de conteúdo de arquivo: selecione o formato do conteúdo do arquivo (binário ou texto).
- Listar arquivos: ao escolher esta opção, a tela mostra os seguintes campos:
  - Caminho: especifique o caminho do diretório cujos arquivos serão listados.

Criar diretório: ao escolher esta opção, a tela mostra os seguintes campos:
- Caminho: especifique o caminho onde o diretório será criado.
- Diretório: insira o nome do diretório.

Importante: Para garantir o funcionamento desta operação, verifique se o seu Agente está atualizado.

RFC

Em módulos do tipo RFC, a área de requisição contém os seguintes campos:

Parâmetros disponíveis: lista dos parâmetros criados previamente;
Nome da função: especifique o nome da função que será executada no sistema SAP.
Parâmetro: insira os parâmetros necessários para a execução da função escolhida.

A query do MongoDB deve começar com o "db."

Estrutura de Saída

Nesta etapa, você testará a operação com as informações fornecidas. Para facilitar, organizamos as orientações por tipo de conectividade. Clique na opção adequada:

Banco de Dados

Para concluir as configurações do módulo do tipo Banco de Dados, a tela de "Estrutura de Saída" é dividida em dois blocos: Entrada e Saída.

Saída: Antes do teste, nenhuma informação é exibida. Após o teste, o resultado é mostrado aqui.