Gateway Fluid - v1

6min
Esta é a documentação da v1 (versão 1, legada) do Fluid API Gateway.
Para a documentação da última versão v2, acesse Gateway Fluid﻿.
Para disparar um evento/webhook para Fluid para iniciar a execução de um fluxo, é necessário fazê-lo via Gateway.
O gateway_host é um endereço de acordo com os Workspaces﻿ definidos para cada cliente. Consulte o o seu gateway_host com a nossa equipe.
Disparando um evento Assíncrono
Um evento/webhook para executar um fluxo de forma assíncrona retorna 200 como HTTP status code e o EventID gerado na plataforma.
Shell
curl --location '{gateway_host}/flows/{flow_name}?key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
curl --location '{gateway_host}/flows/{flow_name}?key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
﻿
Disparando um evento Síncrono
Um evento/webhook para disparar um fluxo de forma síncrona vai manter a requisição aberta até obter a resposta assim que finalizar a execução do fluxo.
Eventos/webhooks síncronos devem ser usados com fluxos com tempo de resposta de até 29 segundos. Caso o fluxo leve 29 segundos ou mais para finalizar, deverá ser usado o disparo assíncrono.
Shell
curl --location '{gateway_host}/flows/{flow_name}/sync?key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
curl --location '{gateway_host}/flows/{flow_name}/sync?key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
﻿
Definir o response resultante de um fluxo síncrono
No evento síncrono, para retornar um response, é necessário informar o nome do passo do fluxo que gerará o retorno, através do parâmetro de query return_step, como no exemplo abaixo:
Shell
curl --location '{gateway_host}/flows/{flow_name}/sync?return_step={step_name}&key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
curl --location '{gateway_host}/flows/{flow_name}/sync?return_step={step_name}&key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
﻿
Caso o retorno do passo seja um array de objetos, será necessário adicionar um parâmetro chamado return_array com valor true, como no exemplo abaixo:
shel
curl --location '{gateway_host}/flows/{flow_name}/sync?return_step={step_name}&return_array=true&key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
curl --location '{gateway_host}/flows/{flow_name}/sync?return_step={step_name}&return_array=true&key={api_key}' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
﻿
Setar o Header Content-Type do response
No evento síncrono, por padrão, o Content-Type do response é application/json. Caso seja necessário setar um outro valor para este header, passe por parâmetro de query  hct(header content-type), como no exemplo abaixo:
Shell
curl --location '{gateway_host}/flows/{flow_name}/sync?key={api_key}&hct=application/vnd.vtex.checkout.minicart.v1%2bjson' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
curl --location '{gateway_host}/flows/{flow_name}/sync?key={api_key}&hct=application/vnd.vtex.checkout.minicart.v1%2bjson' \
--header 'Content-Type: application/json' \
--data '{
    "teste":"body"
}'
﻿
﻿
Updated 23 Apr 2024
Did this page help you?
Gateway Fluid
Visualizar