Structure de l'URL du point de terminaison de l'API

In this section, you can learn to construct API requests by understanding the URL structure of UiPath® endpoints.

URL de base

L'URL de base est le point de départ de toutes les requêtes d'API. Elle sert de base pour créer l'URL du point de terminaison. Pour Automation Suite, l'URL de base est https://{yourDomain}.

Chemin du service

Le chemin du service identifie le service spécifique avec lequel vous souhaitez interagir.

Pour les API fonctionnant au niveau de l'organisation, le chemin du service se place généralement juste après l'URL de base. Ces API fournissent des fonctionnalités applicables à l'ensemble de l'organisation, quels que soient les locataires spécifiques au sein de cette organisation.

/identity_ - pour interagir avec les fonctionnalités associées à la création, la mise à jour ou la suppression de comptes, ainsi que la gestion des paramètres de l’organisation.

/audit_ - pour interagir avec les fonctionnalités associées aux journaux d’audit de l’organisation.

/lrm - pour interagir avec les fonctionnalités associées à l’attribution de licences aux locataires et aux services de l’organisation.

/la - pour suivre l’utilisation des licences (Robot Units, locataires et services enregistrés, etc.)

Lorsqu'il s'agit d'API spécifiques à un locataire particulier au sein d'une organisation, l'URL doit inclure des paramètres supplémentaires de manière à spécifier l'organisation et le locataire avant le chemin de service. Par exemple :

/{orgName}/{tenantName}/orchestrator_ - pour interagir avec les ressources Orchestrator d’un locataire et d’une organisation spécifiques.

/{orgName}/{tenantName}/dataservice_ - pour interagir avec les ressources Data Service d’un locataire et d’une organisation spécifiques.

Pour plus de détails sur les ressources API pour les locataires, reportez-vous à la documentation du produit concerné.

Entry point

api - indique le point d’entrée vers les ressources API de gestion de plate-forme, par exemple ​/api​/Group​/

Chemin de la ressource

Le chemin de la ressource spécifie la ressource ou l'opération exacte que vous souhaitez effectuer. Ce chemin peut inclure des mots-clés tels que Group, RobotAccount ou Setting, en fonction de l'objet de la requête.

Paramètres de chemin d'accès

Les paramètres de chemin d’accès sont utilisés pour transmettre des valeurs dynamiques à un point de terminaison de l’API. Ces valeurs permettent d’identifier des ressources spécifiques relatives à la requête d’API. Par exemple, ​/Group​/{partitionGlobalId}​/{groupId}

partitionGlobalId - l’ID de l’organisation.

groupId - l’ID du groupe.

Paramètres de requête

Les paramètres de requête sont des paramètres supplémentaires rattachés à l'URL afin de fournir davantage de contexte ou de filtres pour les données demandées. Ils sont souvent précédés d'un ? et séparés par le caractère &. Vous pouvez par exemple utiliser des paramètres de requête afin de préciser les critères de filtrage ou les instructions de pagination

Exemple

Si l'on assemble tous les éléments qui la composent, l'URL d'une ressource spécifique à une organisation pourra ressembler à ceci : https://{yourDomain}/identity_/api/group/{partitionGlobalId}​/{groupId}.

L'URL d'une ressource spécifique à un locataire pourra ressembler à ceci : https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Assets.