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

Criar Cliente de API

Criar Cliente de API

Configura um cliente de API reutilizável: certificado de cliente (mTLS), autoridade certificadora (CA), URL base, cabeçalhos padrão e autenticação OAuth2. As ações de Requisição de API que selecionarem este cliente passam a usar essa configuração, sem precisar repeti-la em cada requisição.


Opções​

Certificado de cliente (mTLS)​

Use quando a API exige que o cliente se identifique com um certificado digital (TLS mútuo), comum em integrações bancárias, governamentais e entre empresas.

Caminho do certificado (.pfx)​

Informe o caminho do arquivo do certificado no formato PKCS#12 (.pfx ou .p12), que reúne o certificado e a chave privada. O arquivo precisa existir no dispositivo que executa o robô.

Senha do certificado​

Informe a senha que protege o arquivo do certificado.

Caminho da CA (opcional)​

Informe o caminho do certificado da autoridade certificadora (CA) do servidor. Só é necessário quando o servidor usa uma autoridade certificadora privada ou autoassinada.

Configurações padrão​

URL base​

Informe o início comum dos endereços da API, por exemplo https://api.parceiro.com.br/v1. As ações de Requisição de API que usarem este cliente podem informar só o caminho (ex.: /pedidos).

Cabeçalhos padrão​

Informe, em código, os cabeçalhos enviados em todas as requisições que usarem este cliente. O código deve retornar os cabeçalhos, como objeto ou new Headers(...):

js
return {
  "Accept": "application/json",
}

Autenticação (OAuth2 client credentials)​

Preencha quando a API usa o fluxo OAuth2 client credentials. O cliente obtém o token de acesso sozinho e o envia no cabeçalho Authorization de cada requisição, então não é preciso montar esse cabeçalho à mão.

URL do token​

Informe o endereço que emite o token de acesso. A autenticação só é configurada quando este campo é preenchido.

Client ID​

Informe o identificador do cliente fornecido pelo provedor da API.

Client secret​

Informe o segredo do cliente fornecido pelo provedor da API.

Scope (opcional)​

Informe os escopos solicitados, quando o provedor exigir.

Audience (opcional)​

Informe o público (audience) do token, quando o provedor exigir.

Enviar credenciais em​

Selecione como o Client ID e o Client secret são enviados ao pedir o token:

  • Cabeçalho Authorization (Basic) — padrão, o mais comum.
  • Corpo da requisição — para provedores que esperam client_id e client_secret no corpo.

Retornos​

Esta ação não possui campos de saída para seleção. O cliente criado é usado pelo campo Cliente de API (opcional) da ação Requisição de API.

Exemplo de uso​

  1. Adicione a ação Criar Cliente de API no início do fluxo, com o certificado, a URL base https://api.parceiro.com.br/v1 e os dados de autenticação.
  2. Adicione uma Requisição de API depois dela, selecione o cliente no campo Cliente de API (opcional) e informe só o caminho /pedidos na URL.
  3. Repita o passo 2 para as demais chamadas à mesma API — todas reaproveitam o certificado, os cabeçalhos e o token.

Regras e Condições​

  • A ação precisa estar no mesmo fluxo das requisições que a usam, e antes delas.
  • Os arquivos do certificado e da CA são lidos no dispositivo que executa o robô.
  • O certificado é validado na criação do cliente: caminho inexistente, arquivo corrompido ou senha errada fazem esta ação falhar, e não a primeira requisição.
  • Com a URL do token preenchida, o cliente autentica já na criação. Se o provedor recusar as credenciais ou a resposta não trouxer access_token, esta ação falha.
  • O token é renovado automaticamente pouco antes de expirar. Se a API responder 401, o cliente autentica de novo e repete a requisição uma única vez.
  • Quando o mesmo cabeçalho aparece em mais de um lugar, vale o mais específico: cabeçalhos padrão do cliente < token de autenticação < cabeçalhos da própria requisição. Nomes de cabeçalho não diferenciam maiúsculas de minúsculas.
  • A configuração do cliente, incluindo a senha do certificado e o Client secret, fica disponível em actions["id-da-acao"] durante a execução. Evite registrar esse valor em logs e guarde a senha e o Client secret em parâmetros do tipo senha, em vez de digitá-los na ação.