Accès à l’API

Vue d'ensemble (Overview)

Ouvrir l'API (Open API) de Data Service vous permet de gérer les ressources UiPath Data Service à partir d'une application externe de votre choix en vous permettant d'autoriser l'application externe sans partager d'informations d'identification via le cadre d'autorisation Oauth 2.0.

Découvrez comment enregistrer l'application externe dans UiPath Automation Cloud.

Autorisations d'API

Pour utiliser OpenAPI de Data Service, vous devez accorder des autorisations d'API à l'application externe. Ces autorisations d'API sont nommées « étendues », et il en existe trois types pour Data Service :

• DataService.Schema.Read : cette étendue d'utilisateur (User Scope) permet à votre application externe de lire le schéma Data Service de votre locataire, et dépend des autorisations de l'utilisateur.
• DataService.Data.Read : cette étendue d'utilisateur (User Scope) permet à votre application externe de lire les données Data Service de votre locataire, et dépend des autorisations de l'utilisateur.
• DataService.Data.Write : cette étendue d'utilisateur (User Scope) permet à votre application externe de modifier les données Data Service de votre locataire en supprimant, en mettant à jour ou en créant de nouvelles données, et dépend des autorisations de l'utilisateur.

En savoir plus sur les rôles et les autorisations des utilisateurs dans Data Service.

Télécharger la spécification OpenAPI

À l'aide de votre application externe et des autorisations utilisateur définies, téléchargez la spécification OpenAPI des données Data Service de votre locataire. Pour ce faire, accédez au menu en haut à droite de l'onglet Data Service du locataire > Accès à l'API (API Access) > Télécharger le fichier OpenAPI (JSON) [Download OpenAPI file (JSON)].

Vous obtiendrez ainsi les spécifications OpenAPI 3.0 des entités Data Service de votre locataire au format JSON. Cliquer sur le lien Copier le lien OpenAPI (Copy OpenAPI link) copie le point de terminaison d'API qui génère la spécification OpenAPI Data Service du locataire.

Autoriser les appels d'API

Pour accéder aux ressources de Data Service à l'échelle des utilisateurs, autorisez votre application externe via l'une des méthodes suivantes :

• Code d'autorisation (pour les applications externes confidentielles)

• Code d'autorisation avec PKCE (pour les applications externes non confidentielles)

Points de terminaison de l’API

Le cadre d'autorisation OAuth2.0 vous aide à générer un jeton d'accès qui permet à votre application externe d'effectuer des appels d'API REST aux points de terminaison de Data Service pendant une durée limitée (une heure). Pour continuer à appeler les API, vous devez générer un nouveau jeton d'accès ou demander un jeton d'actualisation.

Les points de terminaison d'API Data Service présentent la syntaxe suivante :

• Méthode HTTP + BaseURL + La catégorie de ressource + L'entité Data Service + L'Opération + Les variables de chemin d'accès et les paramètres de recherche

  
  

  

  
  

  Exemple d'entité de Data Service

  Pour décrire chaque corps de recherche/réponse API, nous utilisons les champs d'entité Jeux olympiques (Olympics) créés dans Data Service. Lorsque nous documentons le point de terminaison générique, tel que Get Entity Records, votre point de terminaison contient le nom exact de votre entité (par exemple, Get Olympics Records). Les corps de réponse et de demande incluent tous les champs de votre entité, reproduisant ainsi la structure de l'entité.
  
  

  

  
  

  Découvrons chaque point de terminaison et voyons comment les utiliser à bon escient.