Introdução às APIs externas

Esta página mostra como fazer sua primeira chamada de API autenticada para a UiPath. Ele usa o fluxo de credenciais do cliente com um aplicativo externo confidencial — o ponto de partida recomendado para scripts de produção, automação administrativa e trabalho de integração.

Observação:

Escolha da ferramenta certa

A documentação do UiPath Swagger permite explorar os pontos de extremidade de API disponíveis e entender os formatos de solicitação e resposta de forma interativa em um navegador. Use o Swagger apenas para descoberta e testes manuais. Para automação de produção, scripts e integração, use Postman, cURL ou o código de seu aplicativo — eles são compatíveis com o fluxo completo de tokens de portador do OAuth 2.0 necessário para autorizar solicitações para APIs da UiPath.

Pré-requisitos

• Um administrador da UiPath Organization registrou um aplicativo externo confidencial com o tipo de concessão Credenciais do cliente e atribuiu os escopos necessários a ele.
• Você tem o ID do aplicativo e o Segredo do aplicativo registrado.

Para obter informações sobre o registro de aplicativos externos e escolha do tipo de concessão correto, consulte Aplicativos externos (OAuth).

Etapa 1: obter um token de portador

Envie uma solicitação POST ao ponto de extremidade do token do Identity Server para receber um token de portador.

curl -X POST "https://cloud.uipath.com/{organizationName}/identity_/connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id={app_id}&client_secret={app_secret}&scope={scopes}"

Substitua os seguintes espaços reservados:

Espaço reservado	Valor
{organizationName}	Nome da sua organização conforme aparece no URL do Automation Cloud
{app_id}	O ID do aplicativo do registro do seu aplicativo externo
{app_secret}	O Segredo do aplicativo do registro do aplicativo externo
{scopes}	Lista separada por espaço de escopos concedidos ao aplicativo, por exemplo: OR.Users.View PM.Users

A resposta retorna um token de portador:

{
    "access_token": "{access_token}",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "{scopes}"
}

Copie o access_token . O token é válido por uma hora.

Observação:

Se você estiver usando o Postman ou uma ferramenta semelhante, defina o tipo de conteúdo da solicitação como application/x-www-form-urlencoded.

Etapa 2: chamar um ponto de extremidade de API

Inclua o token de portador no Authorization de sua solicitação de API.

O exemplo a seguir recupera uma lista de máquinas do Orchestrator:

curl -X GET "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Machines" \
  -H "Authorization: Bearer {access_token}" \
  -H "accept: application/json"

Substitua {tenantName} pelo nome do seu tenant do Orchestrator e {access_token} pelo token da Etapa 1.

Resultado

Uma solicitação bem-sucedida retorna HTTP 200 com os dados solicitados no formato JSON.

Se a solicitação falhar, verifique o seguinte:

• O token não expirou. Os tokens expiram após uma hora — repita a Etapa 1 para solicitar um novo token.
• O valor do cabeçalho Authorization é formatado exatamente como Bearer {access_token}.
• Os escopos concedidos ao seu aplicativo externo cobrem o ponto de extremidade solicitado. Para encontrar os valores de escopo para um ponto de extremidade específico, consulte a página de documentação desse ponto de extremidade neste guia, especificamente no capítulo APIs de gerenciamento de plataforma .

Próximas Etapas

• Para todos os tipos de concessão e fluxos do OAuth — incluindo Código de Autorização e PKCE para acesso delegado do usuário — consulte Aplicativos externos (OAuth).
• Para todos os pontos de extremidade do Identity Server usados na autenticação, consulte Pontos de extremidade do UiPath Identity Server.
• Para entender como estruturar URLs de ponto de extremidade de API, consulte Estrutura do URL de ponto de extremidade de API.