Présentation de l'API Automation Hub

La fonctionnalité Open API permet aux utilisateurs d’UiPath Automation Hub d’accéder et de manipuler les données de leurs locataires de manière programmatique. Sur la base des commentaires reçus, ainsi que de la structure de la plateforme, nous nous sommes concentrés sur la fourniture de requêtes d'API, comme dans les exemples ci-dessous :

Remarque :

• La liste complète des appels API se trouve dans la documentation Swagger et Postman .
• Vous trouverez quelques exemples rapides d'utilisation des appels d'API dans Exemples d'appels d'API. Pour une expérience détaillée ou pour tester des réponses d'API spécifiques, utilisez l'environnement Swagger ou Postman décrit dans Références d'API.

Évaluations personnalisées

• GET/idea-schema
• POST/idea-from-schema
• GET/automations/{automationId}/schema
• PATCH/automations/{automationId}

Idées d’automatisation

• GET/automations
• GET/automations/collaborators
• DELETE/automations/{automationId}/collaborators
• POST/automations/{automationId}/collaborators
• GET/automations/{automationId}/documents
• POST/automations/{automationId}/documents
• GET/automations/{automationId}/components
• GET/questionnaire
• GET/cba
• PUT/automations/cba/{automationId}/project-plan-baseline
• POST/automationidea
• POST/coe-automationidea
• POST/processmining-idea
• POST/automations/{automationId}/media
• POST/automations/status
• POST/automations/{automationId}/tags
• PUT/automation/{automationId}/categories

Remarque :

Les points de terminaison POST /automationidea, POST /coe-automationidea et POST /processmining-idea sont des points de terminaison hérités qui ne peuvent être utilisés que lorsque les évaluations de flux d'idées et les workflows n'ont pas été personnalisés. Pour toutes les nouvelles intégrations et les flux d'idées personnalisés, l'approche recommandée consiste à utiliser GET /idea-schema pour récupérer la structure du formulaire de soumission, puis POST /idea-from-schema pour soumettre l'idée.

Ensemble des automatisations

• GET/automationpipeline

Utilisateurs

• GET/users
• GET/roles
• POST/adduser
• POST/edituser

Inventaire des applications

• GET/appinventory
• PUT/appinventory
• DELETE/appinventory/{applicationId}

Categories

• GET/hierarchy
• PUT/categories

Composants

• GET/components

Magasin d’automatisations

• GET/automation-store
• GET/automation-store/{automationId}/reviews

Les appels d'API intègrent les actions qu'un utilisateur peut effectuer dans l'interface Automation Hub.

Pour commencer à effectuer des appels avec les variables suivantes, accédez aux options OpenAPI à partir de la plate-forme Automation Hub > Console d'administration (Admin Console) > Configuration de la plate-forme (Platform Setup) > Open API et générez votre jeton.

Variable	Valeur (Value)
Jeton	Jeton généré à partir de l'interface utilisateur d'Automation Hub.
URL	https:///{orgName}/{tenantName}/automationhub_/api/v1/openapi
URL de publication différée	https:///{orgName}/{tenantName}/automationhub_/api/v1/openapi
Structure la requête API « GET all ideas » pour les organisations à publication différée	https:///{orgName}/{tenantName}/automationhub_/api/v1/openapi
Clé d'application	La clé d'application générée à partir de l'interface utilisateur d'Automation Hub.

Remarque :

{orgName} et {tenantName} sont des variables qui font référence au nom de votre organisation et au nom de votre locataire.

L'étape suivante consiste à Utiliser les API disponibles.

Références d'API

La définition Swagger de l'API Automation Hub est accessible directement en ajoutant les détails de l'authentification dans la clé d'autorisation de l'appel de demande intitulé En-tête.

https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Le présent guide est conçu pour prendre en charge la documentation Swagger, en fournissant des exemples pertinents et faciles à suivre.

Pour utiliser la documentation Swagger dans les Organisations disposant de la fonctionnalité de publication différée, utilisez le lien suivant :

https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Si vous préférez travailler avec Postman, créez un environnement Postman. Ensuite, consultez notre collection d'API disponible dans Postman. La collection peut être importée en cliquant sur le bouton Exécuter dans Postman .