Consumir la API de Cloud

Información general

Sector público de Automation Cloud de UiPath tiene dos mecanismos para consumir API:

• obtener la información de acceso a la API de Sector público de Automation Cloud (descrita en esta página)
• registrar una aplicación externa para utilizar el flujo OAuth (información e instrucciones).

¿Qué mecanismo utilizar? Puedes utilizar el mecanismo que quieras, pero si tu organización del Sector público de Automation Cloud utiliza el modelo de Azure Active Directory, debes registrar las aplicaciones externas en Sector público de Automation Cloud y utilizar el flujo de OAuth.

Nota:

Todos los clientes que solían conectarse a Orchestrator CE a través de la API o mediante PowerShell y otras herramientas de scripting deben actualizarse para poder conectarse a Sector público de Automation Cloud de UiPath.

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.

Obtener la información de acceso a la API de la IU del Sector público de Automation Cloud

La página Servicios dentro de tu cuenta de Automation Cloud te permite acceder a información específica de la API para cada uno de tus servicios existentes, lo que te permite encontrar fácilmente la información necesaria para la autenticación en tus servicios de Orchestrator basados en la nube mediante llamadas API.

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. Inicia sesión en tu cuenta de Sector público de Automation Cloud.
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 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.

Autenticarse en tu tenant de Sector público de Automation Cloud basada en Orchestrator

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://govcloud.uipath.us/{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://govcloud.uipath.us/{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://govcloud.uipath.us/{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:

Ten en cuenta que, para los servicios de Sector público de Automation Cloud de Orchestrator, los resultados mostrados por las solicitudes de API están limitados a 1000 entradas por página.

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