Consumir la API de Cloud

Información general

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.

Nota:

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.

El Orchestrator local u Orchestrator instalado en tu nube privada no se han cambiado. Puedes seguir utilizando tus integraciones de API, PowerShell u otras herramientas de scripting como antes al conectarte a estas instancias de 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.

Nota:

Los usuarios locales , independientemente de su rol a nivel de organización, pueden ver la información de acceso a la API para los servicios de Orchestrator.

Los usuarios del directorio no pueden ver la información de acceso a la API para un servicio de Orchestrator como se describe a continuación. En su lugar, deben registrar una aplicación externa y utilizar el flujo OAuth.

1. Log in to your Automation Cloud^TM account.
2. Dirígete a Admin > Tenants. La página Tenants enumera todos los tenants existentes.
3. Haga clic en la flecha a la izquierda del tenant deseado para mostrar sus servicios disponibles.
4. Haz clic en Acceso a la API para el servicio de Orchestrator. La ventana de acceso a la API se abre e incluye la siguiente información específica del servicio:

• Clave de usuario: permite generar claves de inicio de sesión únicas para utilizarlas con las API o con aplicaciones de terceros con el fin de iniciar sesión y realizar acciones en tu nombre. Esto se conocía anteriormente como token de actualización.
• ID de la organización: el nombre de tu organización. Es el nombre que aparece después de la URL base.
• Nombre del tenant : el nombre para mostrar del tenant.

• ID de cliente: específico de la propia aplicación de Orchestrator, es el mismo para todos los usuarios y tenants en una plataforma concreta. Por ejemplo, todos los tenants en https://cloud.uipath.com tienen el mismo valor ID de cliente.

  
  

  

  
  

No cierre esta ventana. Necesita la información para realizar la llamada de autenticación. Copie los valores haciendo clic en el botón copiar junto a cada campo.

Authenticating to Your Automation Cloud^TM Based Orchestrator Tenant

La operación de autenticación envía una solicitud POST a https://account.uipath.com/oauth/token. La solicitud y la respuesta deben tener el aspecto del siguiente ejemplo:

Publicar

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

Encabezado de la solicitud

Clave	Valor
Autorización	Portador

Solicitar cuerpo

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

Código de respuesta

200 OK

Cuerpo de respuesta

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

Nota: obtienes los valores {tenant_name}, {client_ID} y {user_key} de tu página de Acceso a la API, como se describe en la sección anterior.

Copie {access_token} para usarlo más adelante.

Importante: el {access_token} requerido para hacer llamadas a la API de Orchestrator es válido por 24 horas. Tiene que regenerar {access_token} usando su {refresh_token}; de lo contrario, recibirá un código de estado 401.

Realizar llamadas a la API de Orchestrator

1. Realizar una solicitud GET a https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
2. Reemplaza {organization_name} y {tenant_name} con tus valores de la página de Acceso a la API.
3. Establece el encabezado de autorización en Bearer {access_token}y pega el valor {access_token} recibido en el procedimiento anterior.

Después de enviar la solicitud, deberías obtener una respuesta de Orchestrator con la información de la licencia para este servicio.

La solicitud y la respuesta deben tener el aspecto del siguiente ejemplo:

Obtener

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

Encabezado de la solicitud

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@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 las llamadas a la API de Orchestrator posteriores a la autorización inicial deben ir a la URL de Orchestrator .

Deben contener el siguiente encabezado:

• Authorization: Bearer {access_token}

Para acceder a los recursos de una carpeta, no olvides añadir FolderId o FolderPath en un encabezado HTTP, como se explica en la página Crear solicitudes de API. Por ejemplo:

• 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.

Puede utilizar parámetros $top y $skip en sus solicitudes para recuperar las páginas posteriores. Por ejemplo, utiliza la solicitud GET https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/RobotLogs?$top=1000&$skip=2000 para recuperar las entradas de registro del robot entre 2.001 y 3.000.