Consumindo API de Cloud

Visão geral

UiPath Automation Cloud^TM has two mechanisms for consuming APIs:

• getting the API access information from Automation Cloud^TM (described on this page)
• registering an external application to use the OAuth flow ( information and instructions ).

Which mechanism to use? You can use whichever mechanism you want, but if your Automation Cloud^TM organization uses the Azure Active Directory model , you must register external applications in Automation Cloud^TM and use the OAuth flow.

Observação:

All clients that used to connect to Orchestrator CE via API, or using PowerShell and other scripting tools, need to be updated in order to connect to the UiPath Automation Cloud^TM.

O On-premises Orchestrator ou o Orchestrator instalado em sua nuvem privada não foram alterados. Você pode continuar usando suas integrações de API, PowerShell ou outras ferramentas de script como antes ao se conectar a essas instâncias do Orchestrator.

Getting the API Access Information From the Automation Cloud^TM UI

The Services page within your Automation Cloud^TM account enables you to access API specific information for each of your existing services, allowing you to easily find the information required for authenticating to your cloud-based Orchestrator services via API calls.

Observação:

Os usuários locais , independentemente de sua função no nível da organização, podem visualizar informações de acesso à API para serviços do Orchestrator.

Usuários do diretório não podem visualizar informações de acesso à API para um serviço do Orchestrator conforme descrito abaixo. Em vez disso, devem registrar um aplicativo externo e usar o fluxo do OAuth.

1. Log in to your Automation Cloud^TM account.
2. Navegue até Administrador > Tenants. A página Tenants lista todos os tenants existentes.
3. Clique na seta à esquerda do inquilino desejado para exibir seus serviços disponíveis.
4. Clique em Acesso à API para o serviço do Orchestrator. Será aberta a janela Acesso à API, incluindo as seguintes informações específicas do serviço:

• Chave do usuário - permite que você gere chaves de login exclusivas para serem usadas com os APIs ou aplicativos de terceiros para fazer login e executar ações em seu nome. Isso era conhecido anteriormente como seu token de atualização.
• ID da organização - nome de sua organização. É o nome após o URL base.
• Nome do inquilino - o nome de exibição do inquilino.

• ID do cliente - específico para o próprio aplicativo Orchestrator, é o mesmo para todos os usuários e tenants em uma plataforma específica. Por exemplo, todos os tenants em https://cloud.uipath.com têm o mesmo valor de ID do cliente.

  
  

  

  
  

Não feche esta janela. Você precisa das informações para fazer a chamada de autenticação. Copie os valores clicando no botão copiar ao lado de cada campo.

Authenticating to Your Automation Cloud^TM Based Orchestrator Tenant

A operação de autenticação envia uma solicitação POST para https://account.uipath.com/oauth/token. A solicitação e a resposta devem se parecer com o exemplo a seguir:

Postar

https://account.uipath.com/oauth/token

Solicitar cabeçalho

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
    "grant_type": "refresh_token",
    "client_id": "{client_ID}",
    "refresh_token": "{user_key}"
}

Código de resposta

200 OK

Corpo da Resposta

{
  "access_token": "{access_token}",
  "id_token": "{id_token}",
  "scope": "openid profile email offline_access",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Observação: você obtém os valores valores {tenant_name}, {client_ID} e {user_key} a partir de sua página Acesso à API, conforme descrito na seção anterior.

Copie o {access_token} para uso posterior.

Importante: o {access_token} necessário para fazer chamadas de API do Orchestrator é válido por 24 horas. Você tem que regenerar {access_token} usando seu {refresh_token}; caso contrário, você receberá um código de status 401.

Fazendo chamadas de API do orquestrador

1. Execute uma solicitação GET para https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
2. Substitua {organization_name} e {tenant_name} por seus valores na página Acesso à API.
3. Defina o cabeçalho de autorização como Bearer {access_token}e cole o valor {access_token} recebido no procedimento acima.

Após enviar a solicitação, você deverá obter uma resposta do Orchestrator com as informações de licença para este serviço.

A solicitação e a resposta devem se parecer com o exemplo a seguir:

Obter

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense

Solicitar cabeçalho

Chave	Valor
Autorização	O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
    "HostLicenseId": null,
    "Id": 0,
    "ExpireDate": 1622678399,
    "GracePeriodEndDate": 1622678399,
    "GracePeriod": null,
    "AttendedConcurrent": false,
    "DevelopmentConcurrent": false,
    "StudioXConcurrent": false,
    "LicensedFeatures": [],
    "IsRegistered": true,
    "IsExpired": false,
    "CreationTime": "2019-11-28T06:16:21.373Z",
    "Code": "d1c8-4785-55ace9a0c233",
    "Allowed": {
        "Unattended": 1,
        "Attended": 1,
        "NonProduction": 0,
        "Development": 1,
        "StudioX": 0
    },
    "Used": {
        "Unattended": 0,
        "Attended": 0,
        "NonProduction": 0,
        "Development": 1,
        "StudioX": 0
    }
}

Importante:

Todas as chamadas de API do Orchestrator subsequentes à autorização inicial devem ir para o URL do Orchestrator.

Elas têm que conter o seguinte cabeçalho:

• Authorization: Bearer {access_token}

Para acessar recursos em uma pasta, lembre-se de adicionar o FolderId ou o FolderPathem um cabeçalho HTTP, conforme explicado na página Criação de solicitações de API. Por exemplo:

• X-UIPATH-OrganizationUnitId: {FolderId}

Importante:

Note that, for Automation Cloud^TM Orchestrator services, the results displayed by the API requests are limited to 1,000 entries for each page.

Você pode usar os parâmetros $top e $skip em suas solicitações para recuperar as páginas subsequentes. Por exemplo, use a solicitação GET https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/RobotLogs?$top=1000&$skip=2000 para recuperar as entradas de log do robô entre 2.001 e 3.000.