Http

Adicione uma atividade de solicitação HTTP a um fluxo de trabalho da API do Studio Web para realizar chamadas de API baseadas em JSON usando conectores do Integration Service ou credenciais diretas.

A atividade HTTP Request permite que você execute solicitações de API baseadas em JSON dentro do seu fluxo de trabalho. Você pode usar o conector HTTP genérico ou qualquer um dos conectores do Integration Service compatíveis para a autenticação, mas você também tem a opção de usar a atividade sem uma conexão e fornecer os detalhes de autenticação diretamente na solicitação.

A atividade fornece controle total sobre a configuração da solicitação, permitindo a definição dinâmica de métodos, URLs, cabeçalhos e conteúdo do corpo. Após a execução, os dados de resposta ficam disponíveis para referência nas etapas subsequentes do fluxo de trabalho, tornando-os um componente crítico para interagir com APIs externas.

Observação:

Você pode aproveitar o Autopilot para adicionar a solicitação HTTP para você colando o cURL desejado no chat.

Usando a atividade HTTP

Para adicionar uma atividade de solicitação HTTP ao seu fluxo de trabalho:

1. Em sua tela de designer de fluxo de trabalho de API, selecione o ícone de mais (+). O menu Adicionar atividade aparece.
2. Selecione HTTP.
3. No painel Propriedades , configure os seguintes campos:
   • Autenticação— O tipo de autenticação a ser usada, Autenticação manual ou Autenticação baseada em conector.
   • Conector— Se você selecionou Autenticação baseada em conector, selecione o conector a ser usado.
   • Conexão— A conexão estabelecida no Integration Service. Selecione uma conexão existente, selecione + Conexão para adicionar uma nova conexão ou selecione Abrir conexões para gerenciar conexões.
   • Método— O método HTTP para a solicitação, GET, POST, PATCH, DELETE, PUT, OPTIONS ou HEAD.
   • URL da solicitação— O ponto de extremidade da API para a solicitação. Você pode criar URLs dinamicamente usando o Editor de expressão. Por exemplo, anexar um ID recuperado de uma etapa de fluxo de trabalho anterior. Se uma URL base estiver definida, insira um caminho relativo. Para substituí-lo, use uma URL absoluta com o mesmo domínio base.
   • Cabeçalhos— Os cabeçalhos de solicitação como pares de chave-valor. Cabeçalhos usam um formato de objeto JSON e podem ser gerados dinamicamente com o editor de Expressão. Por exemplo:

     {
       "Content-Type": "application/json",
       "Accept": "application/json",
       "Authorization": "Bearer <your-access-token>"
     }
     

   • Parâmetros de consulta— Os parâmetros de consulta. Use o Editor de dicionário para adicionar novos parâmetros. Você pode colar vários parâmetros de uma vez ou editar todos eles como texto.
     • Exemplo: query value "select * from Vendor"(para QuickBooks Online).
   • Corpo— Disponível para todos os métodos HTTP, exceto GET, OPTIONS e HEAD. Compatível com cargas baseadas em JSON, permitindo que você faça referência a dados de saídas da etapa anterior usando o editor de Expressão.
4. Depure o fluxo de trabalho para executar a atividade e gerar campos de saída para uso posterior.

Exemplo de atividade HTTP

Este exemplo a seguir faz uma solicitação POST para HTTPBin, que retorna os dados da solicitação para validação. A solicitação inclui variáveis de caminho dinâmicos, cabeçalhos e um corpo de solicitação estruturado.

Abra a janela Configuração de depuração , cole e salve a seguinte sintaxe JSON na seção Argumentos do projeto :

{
  "id": 12345,
  "name": "John Doe",
  "isActive": true,
  "balance": 2500.75,
  "createdAt": "2025-03-25T12:00:00Z",
  "tags": [
    "premium",
    "verified",
    "active"
  ],
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zipCode": "10001",
    "coordinates": {
      "latitude": 40.7128,
      "longitude": -74.006
    }
  },
  "transactions": [
    {
      "transactionId": "txn_001",
      "amount": 150.5,
      "currency": "USD",
      "timestamp": "2025-03-24T10:30:00Z",
    },
    {
      "transactionId": "txn_002",
      "amount": -75.25,
      "currency": "USD",
      "timestamp": "2025-03-23T08:15:00Z"
    }
  ]
}

1. Em sua tela de designer do fluxo de trabalho da API, adicione uma atividade Script , para gerar um valor de token de portador:

   1. Abra o Editor de expressão e retorne um JSON com uma propriedade chamada bearer_token:

      return {
          "bearer_token": "123321123321"
      }
      

   2. Salve.

2. Adicione uma atividade HTTP à tela do designer.

3. Configure a atividade HTTP da seguinte forma:

   • Método— POST
   • URL da solicitação—Use o Editor de expressão para criar a string de URL com uma variável de caminho de id :

     "https://www.httpbin.org/anything/" + ($workflow.input.id)
     

   • Cabeçalhos— Adicione cabeçalhos especificando um JSON de chave-valor simples. Você também está simulando o processo para adicionar um token de portador como um cabeçalho de autorização:

     {
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Authorization": ("Bearer " + $context.outputs.Javascript_3.bearer_token)
     }
     

   • Corpo da solicitação— Use o Editor de expressão para criar dinamicamente o corpo da solicitação fazendo referência a seu JSON de configuração de execução. O objetivo é passar uma matriz de transações envolvidas dentro de um objeto como a carga da solicitação:

     {
         "transactions": $workflow.input.transactions
     }
     

   Observe que o painel Saída de expressão mostra como deve ser o JSON final com base nos dados de entrada de teste de atividade :

   

4. Depure o fluxo de trabalho para executar a atividade.

5. Verifique o painel Saída para revisar a resposta HTTP.