Pular para o conteúdo principal

HTTP

Visão Geral

O trigger HTTP expõe a integração como um serviço capaz de receber e processar requisições utilizando o protocolo HTTP. Tanto requisições REST quanto SOAP são aceitas.

Configuração

Aqui estão os parâmetros gerais para a configuração do componente. Todos os parâmetros de campos de texto aceitam o uso de variáveis.

Informação adicional

O uso de variáveis em parâmetros de campos de texto é feito utilizando a expressão {{var.nome_da_variavel}}. Para saber mais sobre o uso de variáveis na criação de integrações, acesse a seção Canvas de integrações.

Parâmetros

  • ID do Componente: Obrigatório. Identificador do componente no fluxo de integração.
Informação adicional

Os IDs são únicos por fluxo. Não é possível ter mais de um componente com o mesmo ID.

O ID do Componente não pode conter espaços, deve iniciar com número e pode conter apenas letras sem acentos, números e o caractere _.

  • Nome: Rótulo opcional para identificar o componente visualmente no canvas.
  • Método: Obrigatório. Opções: GET, POST, PUT, DELETE, PATCH
  • URI: Obrigatório. URI que a integração será exposta. Para receber parãmetros de URI, utilizar conforme o padrão: /customer/{customerId}/address. O Parâmetro "customerId" será recebido e disponibilizado no payload para uso futuro.
  • Timeout: Obrigatório. Tempo máximo para execução do fluxo, em milisegundos.
  • Esquema JSON: Opcional. Esquema JSON para validação da requisição. Segue o padrão https://json-schema.org/

Saída

Após a execução da etapa trigger, uma estrutura chave-valor será gerada com os dados de saída. Os dados podem ser acessados pelo contexto de execução em outros componentes em etapas posteriores do fluxo a partir da sintaxe .atributo_da_estrutura, onde:

  • atributo_da_estrutura: atributo retornado na estrutura chave-valor de saída da execução da etapa trigger
Atenção!

Caso ocorra algum erro durante a execução da etapa trigger, a estrutura chave-valor de saída não é gerada.

Aqui estão os atributos gerais da estrutura de saída do trigger:

  • msgID: Identificador único da requisição, gerado automaticamente pelo DHuO. Esse comportamento pode ser sobrescrito e um valor pré definido poder ser atribuído ao campo msgID caso a requisição recebida contenha o header MessageId.
  • inputUri: URI recebida na requisição, incluindo parâmetros de query.
  • inputMethod: Método HTTP chamado.
  • inputHeader: Relação de headers recebidos na requisição no formato chave-valor (nome do header/valor do header).
  • inputBody: Payload recebido na requisição.
  • inputUriParams: Parâmetros de path, configurados no campo URI e query params recebidos na url.
  • inputValidate: Resultado da validação de schema, caso cadastrado no campo "Esquema JSON".

Exemplo:

// URI: /users/{id}?flow=adm
// Método: PUT
{
"inputHeader": {
"Authorization": "Basic XXXXX",
"Messageid": "70B87A08474E4F8AA38D4A51",
},
"inputBody": {
"user": "John Doe",
"email": "john.doe@dhuo.io"
},
"inputUriParams":{
"id": "5f86f22d-88b0-4574-9388-c8926a5c6334",
"flow": "adm"
},
"inputValidate": {
"valid": false,
"errors": {
"error1",
"error2"
}
}
"inputUri": "/run/users/5f86f22d-88b0-4574-9388-c8926a5c6334?flow=adm",
"inputMethod": "PUT",
"msgID": "70B87A08474E4F8AA38D4A51"
}