Chamar uma API externa

Chame uma API de Transferência de Estado Representacional (REST) autenticada, trate a resposta e extraia dados para nós de fluxo de trabalho subsequentes.

O que você criará: um fluxo de trabalho que chama uma API de Transferência de Estado Representacional (REST) autenticada, lida com a resposta e disponibiliza os dados extraídos para nós subsequentes. Esse é um dos padrões mais comuns no Flow — ele se aplica a qualquer sistema que exponha um ponto de extremidade HTTP.

O que você precisa

• Uma conta do UiPath Automation Cloud com acesso ao Maestro Flow.
• O URL base da API de destino, o caminho do ponto de extremidade e os detalhes de autenticação (chave de API, token de portador ou credenciais de autenticação básicas).

Nós usados

• Gatilho manual — inicia o fluxo de trabalho sob demanda
• Solicitação HTTP — chama a API REST
• Transformação de dados — extrai os campos necessários da resposta
• Script — registra falhas no caminho de erro da solicitação HTTP

Etapas

1. Crie um novo fluxo e adicione um gatilho

1. Abra o Maestro → Flow e crie um novo fluxo de trabalho.
2. Arraste um Disparo manual para a tela.

2. Adicione e configure o nó de solicitação HTTP

1. Arraste um nó de solicitação HTTP para a tela e conecte-o ao gatilho.
2. No painel de configuração:
   • Defina Método como o verbo apropriado (GET, POST, PUT, PATCH ou DELETE).
   • Insira o URL completo do ponto de extremidade.
   • Em Cabeçalhos, adicione cabeçalhos de autenticação e tipo de conteúdo.

Para autenticação de chave de API:

Adicione um cabeçalho com a chave Authorization e o valor Bearer {{ secret.apiKey }}. O prefixo secret. informa ao Fluxo para procurar o valor do seu armazenamento de variáveis seguro — nunca cole a chave diretamente no campo.

Para autenticação básica:

Adicione um cabeçalho com a chave e Basic {{ secret.encodedCredentials }} Authorization onde encodedCredentials é a string username:password codificada em base64.

3. Extraia os dados de que precisa

1. Arraste um nó de Transformação de dados para a tela e conecte-o ao nó de Solicitação HTTP.
2. No painel de configuração, mapeie os campos de resposta que você precisa de $vars.httpRequest1.output.body para as variáveis de saída nomeadas.

Por exemplo, para extrair o nome e o email de um usuário de uma resposta como { "user": { "name": "Alex", "email": "[e-mail]" } }, mapeie:

• $vars.httpRequest1.output.body.user.name → userName
• $vars.httpRequest1.output.body.user.email → userEmail

4. Adicione o tratamento de erros

1. Selecione o nó da Solicitação HTTP.
2. Arraste de seu identificador de erro (o conector na parte inferior direita) para um novo nó de Script .
3. No nó do Script, registre o erro de $vars.httpRequest1.error:

const error = $vars.httpRequest1.error;
console.log('API call failed:', error.message, '| Status:', error.status);
return null;

5. Teste e depure

Selecione Teste. No trace de execução:

• Verifique a statusCode do nó de solicitação HTTP. 200 significa sucesso; 401 significa que sua autenticação está errada; 404 significa que o URL está incorreto.
• Verifique a saída do nó Transformação de dados para confirmar que os campos foram extraídos corretamente.
• Para testar o caminho do erro, defina temporariamente o URL com um valor inválido e verifique se o caminho do erro é executado.

Resultado

Seu fluxo de trabalho chama a API REST, extrai os campos necessários da resposta e registra falhas no caminho do erro. Você pode inspecionar o código de status HTTP e os valores extraídos no trace de execução e confirmar que os caminhos de sucesso e erro funcionam conforme o esperado.

Estender este fluxo de trabalho

• Identificar paginação: se a API retornar resultados em várias páginas, adicione nós de acompanhamento HTTP Request para buscar páginas adicionais, ramificando com uma decisão sobre se a resposta inclui um cursor de próxima página.
• Gravar resultados em outro sistema: após o nó Transformação de dados, adicione outro nó HTTP Request ou um nó de integração para enviar os dados por push.
• Agendar: substitua o Disparo manual por um Disparo programado para executar o fluxo de trabalho em intervalos regulares.