REST API / HTTP

Chamadas a APIs REST e GraphQL

Requisição HTTP

rest.http_request

GET, POST, PUT, PATCH, DELETE configurável

Como usar

Chama uma API: escolha o método, a URL (relativa, se a sessão tiver URL base), parâmetros, cabeçalhos e o corpo (JSON, formulário ou texto). A resposta inteira fica na variável; use Analisar Resposta JSON para ler os dados. Por padrão, respostas 4xx/5xx falham o robô; desmarque para tratar o código você mesmo.

Exemplo: POST em /pedidos com corpo JSON {"cliente": "{cliente_id}", "valor": {valor}}, usando a sessão {api} já autenticada.

Campos

Campo	Tipo	Padrão	Detalhes
Método *	Opção	`GET`	Opções: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
URL *	Texto	`https://`	URL absoluta, ou caminho quando houver sessão com URL base
Parâmetros de consulta	Pares chave e valor
Headers	Pares chave e valor
Corpo	Opção	`Nenhum`	Opções: Nenhum, JSON, Formulário (x-www-form-urlencoded), Texto puro
Conteúdo do corpo	Código		Só quando «Corpo» = «JSON» ou «Texto puro»
Campos do formulário	Pares chave e valor		Só quando «Corpo» = «Formulário (x-www-form-urlencoded)»
Salvar resposta na variável *	Variável de saída	`response`

+ Avançado (5)

Campo	Tipo	Padrão
Sessão (opcional)	Variável	`api`
Tempo limite	Número	`30000 ms`
Falhar em HTTP 4xx/5xx	Sim/Não	`Sim`
Validar certificado SSL	Sim/Não	`Sim`
Seguir redirecionamentos	Sim/Não	`Sim`

Resultado: guardado na variável response (Objeto).

Definir URL Base

rest.set_base_url

Define URL base para requisições subsequentes

Como usar

Define a URL base da sessão (criando a sessão se ela ainda não existir); as requisições seguintes podem usar só o caminho, como /clientes.

Exemplo: Defina https://api.erp.empresa.com/v2 como URL base da sessão {api}.

Campos

Campo	Tipo	Padrão	Detalhes
Variável da sessão *	Variável de saída	`api`
URL base *	Texto	`https://`

Resultado: guardado na variável api (Objeto).

Definir Headers

rest.set_headers

Define headers globais (Authorization, Content-Type, etc.)

Como usar

Define cabeçalhos enviados em todas as requisições da sessão, como Accept, Content-Type ou uma chave de API.

Exemplo: Defina X-Api-Key com a credencial ERP_API_KEY na sessão {api}.

Campos

Campo	Tipo	Padrão	Detalhes
Variável da sessão *	Variável de saída	`api`
Headers *	Pares chave e valor

Resultado: guardado na variável api (Objeto).

Definir Auth (Bearer)

rest.set_auth_bearer

Configura autenticação Bearer Token

Como usar

Autentica a sessão com um token Bearer (cabeçalho Authorization), lido do cofre de credenciais.

Exemplo: Use a credencial CRM_TOKEN como Bearer na sessão {api}.

Campos

Campo	Tipo	Padrão	Detalhes
Variável da sessão *	Variável de saída	`api`
Token (cofre) *	Credencial do cofre

Resultado: guardado na variável api (Objeto).

Definir Auth (Basic)

rest.set_auth_basic

Configura autenticação HTTP Basic

Como usar

Autentica a sessão com usuário e senha (HTTP Basic). A senha vem do cofre e não aparece nos logs.

Exemplo: Autentique {api} com o usuário integracao e a senha ERP_SENHA.

Campos

Campo	Tipo	Padrão
Variável da sessão *	Variável de saída	`api`
Usuário *	Texto
Senha (cofre) *	Credencial do cofre

Resultado: guardado na variável api (Objeto).

Definir Auth (OAuth2)

rest.set_auth_oauth2

Fluxo OAuth2 Client Credentials

Como usar

Obtém um token OAuth2 pelo fluxo Client Credentials (ID e segredo do aplicativo) e passa a usá-lo como Bearer na sessão.

Exemplo: Obtenha o token em https://login.parceiro.com/oauth/token com o client ID do robô e o segredo PARCEIRO_SECRET.

Campos

Campo	Tipo	Padrão
Variável da sessão *	Variável de saída	`api`
URL do token *	Texto	`https://`
Client ID *	Texto
Client secret (cofre) *	Credencial do cofre
Escopo	Texto

Resultado: guardado na variável api (Objeto).

Analisar Resposta JSON

rest.parse_json

Parseia corpo da resposta como JSON

Como usar

Lê o corpo de uma resposta como JSON e guarda como dicionário ou lista, para usar campos como {dados.id} ou {dados.itens}.

Exemplo: Analise {response} em {pedido} e use {pedido.numero} no e-mail de confirmação.

Campos

Campo	Tipo	Padrão	Detalhes
Resposta *	Variável	`response`
Salvar resultado na variável *	Variável de saída	`data`

Resultado: guardado na variável data (Dicionário).

Obter Status Code

rest.get_status_code

Retorna o código HTTP da resposta

Como usar

Guarda o código HTTP da resposta (200, 404, 500...). Combine com um Se quando a requisição foi feita sem falhar em erro HTTP.

Exemplo: Se {status_code} == 404, registre "Cliente não encontrado" e siga para o próximo.

Campos

Campo	Tipo	Padrão	Detalhes
Resposta *	Variável	`response`
Salvar resultado na variável *	Variável de saída	`status_code`

Resultado: guardado na variável status_code (Número).

Obter Header da Resposta

rest.get_response_header

Retorna um header específico da resposta

Como usar

Lê um cabeçalho da resposta, como Content-Type, Location ou um cabeçalho de paginação.

Exemplo: Leia o cabeçalho X-Total-Count para saber quantas páginas buscar.

Campos

Campo	Tipo	Padrão
Resposta *	Variável	`response`
Nome do header *	Texto	`Content-Type`
Salvar resultado na variável *	Variável de saída	`header_value`

Resultado: guardado na variável header_value (Texto).

Enviar Arquivo (Multipart)

rest.upload_multipart

Upload via multipart/form-data

Como usar

Envia um arquivo para uma API no formato multipart/form-data, junto com outros campos do formulário.

Exemplo: Envie {caminho_pdf} no campo "arquivo" para /documentos, com o campo pedido = {numero}.

Campos

Campo	Tipo	Padrão
URL *	Texto	`https://`
Arquivo *	Arquivo
Nome do campo do arquivo	Texto	`file`
Outros campos	Pares chave e valor
Salvar resposta na variável *	Variável de saída	`response`

+ Avançado (2)

Campo	Tipo	Padrão	Detalhes
Sessão (opcional)	Variável	`api`
Tempo limite	Número	`300000 ms`

Resultado: guardado na variável response (Objeto).

Baixar Arquivo

rest.download_file

Download de arquivo via HTTP

Como usar

Baixa um arquivo por HTTP para o caminho indicado, usando a autenticação da sessão, e guarda o caminho salvo.

Exemplo: Baixe /relatorios/{id}/pdf para C:\Robos\relatorios\{id}.pdf pela sessão {api}.

Campos

Campo	Tipo	Padrão
URL *	Texto	`https://`
Salvar como *	Arquivo
Salvar caminho do arquivo na variável *	Variável de saída	`downloaded_file`

+ Avançado (2)

Campo	Tipo	Padrão	Detalhes
Sessão (opcional)	Variável	`api`
Tempo limite	Número	`300000 ms`

Resultado: guardado na variável downloaded_file (Caminho de arquivo).

Consulta GraphQL

rest.graphql_query

Executa query/mutation GraphQL

Como usar

Executa uma query ou mutation GraphQL com variáveis em JSON e guarda o campo data da resposta. Erros devolvidos pela API falham o comando com a mensagem deles.

Exemplo: Consulte { pedidos(status: "novo") { id total } } e percorra {data.pedidos}.

Campos

Campo	Tipo	Padrão
Endpoint *	Texto	`https://`
Query / mutation *	Código
Variáveis (JSON)	Código
Salvar resultado na variável *	Variável de saída	`data`

+ Avançado (2)

Campo	Tipo	Padrão	Detalhes
Sessão (opcional)	Variável	`api`
Tempo limite	Número	`30000 ms`

Resultado: guardado na variável data (Dicionário).