Estructura de URL de punto final de la API

En esta sección, puede aprender a construir solicitudes de API entendiendo la estructura de URL de los puntos finales de UiPath®.

URL base

La URL base es el punto de partida para todas las solicitudes de API. Sirve como base para construir la URL del punto final. La URL base es https://{yourDomain}.

Ruta de servicio

La ruta de servicio identifica el servicio específico con el que quieres interactuar.

Para las API que operan en la organización, la ruta de servicio suele aparecer justo después de la URL base. Estas API proporcionan funcionalidades que son aplicables en toda la organización, independientemente de los tenants específicos de esa organización.

/identity_: para interactuar con funcionalidades relacionadas con la creación, actualización o eliminación de cuentas y la gestión de la configuración de la organización.

/audit_: para interactuar con funcionalidades relacionadas con los registros de auditoría en la organización.

/lrm: para interactuar con funcionalidades relacionadas con la asignación de licencias a tenants y servicios de la organización.

/la: para realizar el seguimiento del uso de licencias (unidades de UiPath Robot, tenants y servicios aprovisionados, etc.)

Al tratar con API que son específicas de un tenant en particular dentro de una organización, la URL debe incluir parámetros adicionales para especificar tanto la organización como el tenant antes de la ruta de servicio. Por ejemplo:

/{orgName}/{tenantName}/orchestrator_: para interactuar con recursos de Orchestrator en un tenant y una organización específicos.

/{orgName}/{tenantName}/dataservice_: para interactuar con recursos de Data Service en un tenant y una organización específicos.

Para obtener más detalles sobre los recursos de la API de tenant, consulta la documentación específica del producto.

Punto de entrada

api: significa el punto de entrada a los recursos de gestión de la plataforma API, por ejemplo ​/api​/Group​/.

RutaDeRecurso

La ruta del recurso especifica el recurso o la operación exacta que deseas realizar. Puede incluir palabras clave como Grupo, Cuenta de UiPath Robot, Configuración, dependiendo del propósito de la solicitud.

Parámetros de ruta

Los parámetros de ruta se utilizan para pasar los valores dinámicos a un punto final de la API. Estos valores ayudan a identificar recursos específicos que son relevantes para la solicitud de la API. Por ejemplo, ​/Group​/{partitionGlobalId}​/{groupId}

partitionGlobalId: el ID de la organización.

groupId: el ID del grupo.

Parámetros de consulta

Los parámetros de consulta son parámetros adicionales adjuntos a la URL para proporcionar más contexto o filtros para los datos solicitados. A menudo van precedidos de un ? y separados por símbolos &. Por ejemplo, puedes utilizar parámetros de consulta para especificar los criterios de filtrado o las instrucciones de paginación.

Ejemplo

Al juntar todos los componentes, una URL para un recurso específico de la organización puede tener el siguiente aspecto https://{yourDomain}/identity_/api/group/{partitionGlobalId}​/{groupId}.

Una URL para un recurso específico de tenant puede tener este aspecto: https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Assets.