Primeros pasos con las API externas

Esta página te muestra cómo realizar tu primera llamada a la API autenticada a UiPath. Utiliza el flujo de credenciales de cliente con una aplicación externa confidencial: el punto de partida recomendado para los scripts de producción, la automatización administrativa y el trabajo de integración.

Nota:

Elegir la herramienta adecuada

La documentación de UiPath Swagger te permite explorar los puntos finales de API disponibles y comprender los formatos de solicitud y respuesta de forma interactiva en un navegador. Usa Swagger solo para pruebas manuales y de descubrimiento. Para la automatización de la producción, la creación de scripts y la integración, utiliza Postman, cURL o tu código de aplicación: estos admiten el flujo completo de tokens al portador OAuth 2.0 necesario para autorizar solicitudes a las API de UiPath.

Requisitos previos

• Un administrador de la organización de UiPath ha registrado una aplicación externa confidencial con el tipo de concesión Credenciales de cliente y le ha asignado los ámbitos necesarios.
• Tienes el ID de la aplicación y el Secreto de la aplicación para la aplicación registrada.

Para obtener información sobre el registro de aplicaciones externas y la elección del tipo de concesión correcto, consulta Aplicaciones externas (OAuth).

Paso 1: obtener un token al portador

Envía una solicitud POST al punto final del token de Identity Server para recibir un token al 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}"

Reemplaza los siguientes marcadores de posición:

Marcador de posición	Valor
{organizationName}	El nombre de su organización tal como aparece en la URL de Automation Cloud
{app_id}	El ID de la aplicación de su registro de aplicación externa
{app_secret}	El secreto de la aplicación de tu registro de aplicación externa
{scopes}	Lista separada por espacios de ámbitos concedidos a la aplicación, por ejemplo: OR.Users.View PM.Users

La respuesta devuelve un token al portador:

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

Copia el valor access_token . El token es válido durante una hora.

Nota:

Si utilizas Postman o una herramienta similar, establece el tipo de contenido de la solicitud en application/x-www-form-urlencoded.

Paso 2: llama a un punto final de API

Incluye el token al portador en el encabezado Authorization de tu solicitud de API.

El siguiente ejemplo recupera una lista de máquinas de Orchestrator:

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

Sustituye {tenantName} por el nombre de tu tenant de Orchestrator y {access_token} por el token del paso 1.

Resultado

Una solicitud correcta devuelve HTTP 200 con los datos solicitados en formato JSON.

Si la solicitud falla, verifica lo siguiente:

• El token no ha caducado. Los tokens caducan después de una hora: repite el paso 1 para solicitar un nuevo token.
• El valor del encabezado Authorization tiene el formato exactamente como Bearer {access_token}.
• Los ámbitos concedidos a tu aplicación externa cubren el punto final solicitado. Para encontrar los valores de ámbito para un punto final específico, consulta la página de documentación de ese punto final en esta guía, específicamente en el capítulo API de gestión de plataforma .

Próximos pasos

• Para todos los tipos y flujos de concesión OAuth, incluido el código de autorización y PKCE para el acceso delegado por el usuario, consulta Aplicaciones externas (OAuth).
• Para todos los puntos finales de Identity Server utilizados en la autenticación, consulta Puntos finales de UiPath Identity Server.
• Para comprender cómo estructurar las URL del punto final de la API, consulta Estructura de la URL del punto final de la API.