Pular para o conteúdo principal
Docs
Acessar Studio
Roberty Studio
RPAAPI

Requisição de API

Requisição de API

Realiza uma requisição HTTP para uma URL externa, suportando os principais métodos (GET, POST, PUT, DELETE, OPTIONS) e permitindo configurar cabeçalhos e corpo da requisição.


Opções​

URL da requisição​

Informe a URL completa para a qual a requisição será enviada. Quando um cliente de API com URL base é selecionado nas configurações da requisição, você pode informar só o caminho (ex.: /pedidos).

Método da requisição​

Selecione o método HTTP a ser utilizado: GET, POST, PUT, DELETE ou OPTIONS.

Corpo da requisição​

Informe o corpo (body) da requisição. Copie exatamente o conteúdo esperado pela API de destino.

Cabeçalho da requisição​

Informe os cabeçalhos (headers) necessários para a requisição, como tokens de autenticação, tipo de conteúdo, entre outros.

Cliente de API (opcional)​

Selecione uma ação Criar Cliente de API do fluxo para que a requisição use o certificado de cliente (mTLS), a URL base, os cabeçalhos padrão e a autenticação configurados nela. A ação precisa estar no mesmo fluxo desta requisição, antes dela. Deixe vazio para uma requisição comum.

Retornos​

Código Javascript​

js
actions["id-da-acao"].response    // valor de resposta da API (Qualquer)
actions["id-da-acao"].status      // código de status HTTP (Número)
actions["id-da-acao"].statusText  // texto do status HTTP (Texto)

Seleção de campos​

  • response — valor de resposta da API (Qualquer)
  • status — código numérico de status HTTP, ex: 200, 404, 500 (Número)
  • statusText — texto descritivo do status HTTP, ex: OK, Not Found (Texto)

Regras e Condições​

  • O campo URL da requisição é obrigatório.
  • O método padrão é GET caso não seja selecionado outro.
  • O corpo da requisição deve estar no formato esperado pela API de destino.
  • Com um cliente de API selecionado, cabeçalhos repetidos seguem a precedência: cabeçalhos padrão do cliente < token de autenticação < cabeçalhos desta requisição.
  • Com autenticação configurada no cliente, o token é obtido e renovado automaticamente; se a API responder 401, a requisição é repetida uma única vez com um token novo.