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 l'infrastructure d'autorisation Oauth 2.0.

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

Une fois que vous avez défini les autorisations pour votre application externe et vos utilisateurs, téléchargez la spécification OpenAPI de vos données Data Service locataire :

• Sur la page Data Service, cliquez sur Accès à l'API ( API Access), puis sélectionnez Télécharger le fichier OpenAPI (JSON) (Download OpenAPI file (JSON)).

Cette opération télécharge les spécifications OpenAPI 3.0 de vos entités Data Service 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 de 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).

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é.
  
  

  

  
  

  De plus, utilisons le guide de l'API Data Service pour découvrir chaque point de terminaison et découvrir comment l'utiliser à bon escient.

Accèder aux ressources Data Service à l'aide d'applications externes

Configuration de l'accès précis pour les applications externes

Les applications externes utilisent leurs propres informations d'identification client pour accéder aux ressources Data Service au lieu de se faire passer pour un utilisateur.

Lorsqu'une application externe souhaite effectuer une action dans une entité, Data Service vérifie si l'application dispose des autorisations requises pour accéder aux ressources correspondantes. Comme aucun utilisateur n'est impliqué dans l'authentification, la demande de ressource génère un jeton d'accès qui vérifie les affectations de votre application aux niveaux du locataire et de l'entité. Ce n'est qu'après une validation réussie que l'application externe accède aux ressources pour lesquelles des autorisations lui ont été accordées.

Création d’applications externes

En tant qu'administrateur, suivez ces étapes pour créer une application externe et configurez-la afin d'accéder aux ressources Data Service :

1. Dans votre organisation, accédez à Admin > Applications externes (External Applications). La page Applications externes s'affiche.

2. Cliquer sur Ajouter une application:

   1. Attribuez un nom à votre application externe.

   2. Sélectionnez le type pour votre application externe.

   3. Cliquez sur Ajouter. Votre application externe est affichée dans la liste Applications externes (External applications) .

Indiquer quelque chose à propos de l'étendue dataService.default Pour les applications confidentielles auxquelles des rôles Data Service personnalisés ont été attribués, vous devez demander l'étendue DataService.Default . Cette étendue utilise un jeton d'accès pour vérifier les affectations de votre application aux niveaux du locataire et de l'entité. Ce n’est qu’après une validation réussie que l’application externe peut accéder aux ressources auxquelles l’accès lui a été accordé.

Ajouter des applications externes à un locataire

En tant qu'administrateur Data Service, suivez ces étapes pour accorder à une application externe l'accès à toutes les entités du locataire sélectionné :

1. Dans votre instance de Data Service, accédez à la page Gérer l'accès (Manage Access ).

   

2. Sur la page Gérer l'accès (Manage Access) , cliquez sur le bouton Attribuer des rôles (Assign Roles ).

3. Dans le panneau Attribuer des rôles (Assign Roles ) :

   1. Dans le champ Ajouter des noms (Add names) , saisissez le nom de votre application externe, puis sélectionnez-la dans la liste.

   2. Dans la liste Sélectionner des rôles (Select Roles) , sélectionnez le rôle personnalisé créé auparavant et le rôle Lecteur de données (Data Reader). Vous pouvez sélectionner d'autres rôles que vous souhaitez attribuer à votre application externe, mais Lecteur de données (Data Reader) est une sélection obligatoire.

   3. Cliquez sur Enregistrer. Votre application externe est affichée dans la liste à partir de l'onglet Attribuer des rôles (Assign Roles) .

      

Ajouter des applications externes à une entité

En tant qu'administrateur Data Service, suivez ces étapes pour gérer l'accès d'une application externe à des entités spécifiques :

1. Dans votre instance de Data Service, accédez à la page Gérer l'accès (Manage Access ).

   

2. Sur la page Gérer l'accès (Manage Access) , cliquez sur le bouton Créer un rôle (Create Role) .

3. Dans le panneau Créer un rôle :

   1. Attribuez un nom au rôle personnalisé.

   2. Attribuez les autorisations administratives souhaitées.

   3. Sous la section Autorisations d'accès aux données (Data Access Permissions) , cliquez sur Ajouter une entité(Add Entity), sélectionnez l'entité souhaitée, puis sélectionnez les autorisations que l'application externe peut avoir au sein de cette entité.

   4. Cliquez sur Enregistrer. Le rôle personnalisé de votre application externe est affiché dans la liste de l'onglet Rôles (Roles) .