API de la Control Room

La Automation Anywhere Control Room fournit des API qui vous permettent de personnaliser la manière dont vous (et vos automatisations) interagissez avec Automation Anywhere.

Important :
  • Depuis Automation 360 v.34, les points de terminaison de l\'API WLM suivants sont obsolètes et devraient être abandonnés (fin de vie) à la publication de la v.38 :
    • POST /v3/wlm/workitemmodel
    • GET /v3/wlm/workitemmodels/{id}
    • OBTENIR /v3/wlm/queues/{id}
    • POST /v3/wlm/queues/{id}/consommateurs
    • POST /v3/wlm/queues/{id}/participants
    • PUT /v3/wlm/queues/{id}/members/{userId}
    • POST /v3/wlm/queues/{id}/file
    • PUT /v3/wlm/queues/{id}/workitems/{workItemId}
    Remplacez les points de terminaison d\'API ci-dessus par les points de terminaison d\'API suivants :
    • POST /v4/wlm/workitemmodel
    • OBTENIR /v4/wlm/workitemmodels/{id}
    • OBTENIR /v4/wlm/queues/{id}
    • POST /v4/wlm/queues/{id}/consommateurs
    • POST /v4/wlm/queues/{id}/participants
    • PUT /v4/wlm/queues/{id}/members/{userId}
    • POST /v4/wlm/queues/{id}/file
    • PUT /v4/wlm/queues/{id}/workitems/{workItemId}
  • À partir de Automation 360 v.34, les points de terminaison de l\'API du Bot Scheduler : /v1/schedule/automations sont obsolètes et sont remplacés par /v2/schedule/automations. La version v1 devrait être abandonnée (fin de vie) à la publication de la v.38.

Vous pouvez consulter et parcourir tous les modules d\'API de la Control Room et les points de terminaison associés dans les sections de référence de l\'API suivantes.

Les différentes versions d\'API ci-dessous représentent différentes itérations d\'API au fil du temps. À mesure qu\'une API évolue, de nouvelles fonctionnalités ou améliorations sont introduites. Pour gérer ces changements et conserver la compatibilité avec les applications existantes, les développeurs utilisent la gestion des versions.

Points de terminaison v1

Modules Description
API d\'authentification Utilisez les API d\'authentification v1 pour vérifier l\'authenticité et l\'intégrité des jetons Web JSON (JWT), ainsi que pour mettre fin aux sessions utilisateur actives.
API d\'audit Utilisez les API d\'audit pour récupérer les données du journal d\'audit de votre Control Room.
API de périphérique Utilisez l\'API du périphérique pour identifier tous les utilisateurs disponibles avec des robots non assistés ou filtrer les utilisateurs par nom.
API d\'automatisation Obsolète Utilisez les API du planificateur de Bot v1 (API d\'automatisation) pour créer, mettre à jour, supprimer et retourner des détails sur les automatisations programmées.
API de déclenchement Utilisez les API de déclenchement pour mapper les déclencheurs aux utilisateurs ou aux rôles pour un utilisateur de Bot Runner assisté. Vous pouvez également créer et supprimer des déclencheurs d\'événements.
API d\'exécution de tâches API Utilisez les API d\'exécution de tâche API pour générer une URL d\'exécution de tâche API, ainsi qu\'un jeton pour démarrer une exécution de tâche API via un point de terminaison de l\'API.

Points de terminaison v2

Modules Description
API d\'authentification Utilisez les API d\'authentification v2 pour générer et actualiser les jetons JWT nécessaires à l\'autorisation dans toutes les API Enterprise Control Room.
API de gestion des utilisateurs Utilisez les API de gestion des utilisateurs pour afficher et supprimer des rôles et des utilisateurs dans votre Control Room.
API de coffre des informations d\'identification Utilisez les API de coffre des informations d\'identification pour créer, récupérer, mettre à jour et supprimer des informations d\'identification, des valeurs d\'attribut d\'informations d\'identification, des consignes et des clés.
API d\'orchestrateur d\'exécutions de robot Utilisez l\'API d\'orchestrateur d\'exécutions de robot v2 pour surveiller les périphériques.
API de gestion des référentiels Utilisez les API de gestion de référentiel pour effectuer des tâches spécifiques sur des objets (robots, dossiers et fichiers) auxquels vous êtes autorisé à accéder dans la Control Room.
API BotInsight Utilisez l\'API Bot Insight pour accéder à des données métier en temps réel et à des informations sur les performances de la force de travail numérique, afin d\'utiliser les données de productivité au niveau du contenu provenant des automatisations en cours de déploiement.
API BLM Utilisez l\'API de gestion du cycle de vie des robots (BLM) pour exporter et importer des robots avec des fichiers dépendants et des packages de commande pour une gestion complète du cycle de vie de l\'automatisation.
API de pool de périphériques Utilisez les API de pool de périphériques pour créer, répertorier, mettre à jour et supprimer des pools de périphériques.
API de licence Utilisez les API de licence pour récupérer les détails de la licence de la Control Room et synchroniser manuellement la Control Room avec le serveur de licences après la réaffectation ou le renouvellement de la licence.
API de compositeur de processus Utilisez les API Processor Composer pour créer une nouvelle demande à partir des processus, récupérer le formulaire initial et demander un ID de référence.
API d\'automatisation Utilisez les API du Planificateur de Bot v2 (API d\'Automatisation) pour créer, mettre à jour, supprimer et retourner des détails sur les automatisations planifiées.

Points de terminaison v3

Modules Description
API de déploiement de robots Utilisez l\'API de déploiement de robots v3 pour déployer des robots depuis l\'espace de travail public vers les périphériques Bot Runner.
API de gestion de la charge de travail Utilisez les API de gestion de la charge de travail (WLM) v3 pour gérer et créer par programme des modèles d\'éléments de travail, des files d\'attente, des éléments de travail et des automatisations dans votre Control Room.
API de migration (migration de robot) Utilisez les API de migration v3 pour migrer les TaskBots et les MetaBots créés dans les versions client Enterprise Enterprise 11 et Enterprise 10 vers Automation 360.
API d\'orchestrateur d\'exécutions de robot Utilisez les API d\'orchestrateur d\'exécutions de robot v3 pour surveiller la progression de l\'activité d\'automatisation.

Points de terminaison v4

Modules Description
API de déploiement de robots (V4) Utilisez l\'API v4 Deploy Bot pour déployer des robots depuis l\'espace de travail public vers des appareils Bot Runner.
API de gestion de la charge de travail Utilisez les API de gestion de la charge de travail (WLM) v4 pour gérer et créer par programme des modèles d\'éléments de travail, des files d\'attente, des éléments de travail et des automatisations dans votre Control Room.
API de migration (migration de robot) Utilisez les API de migration v4 pour migrer les TaskBots et les MetaBots créés dans les versions client Enterprise 11 et Enterprise 10 vers Automation 360.
Remarque : Pour éviter les erreurs et assurer un traitement fluide de vos demandes, n\'oubliez pas que tous les noms des paramètres JSON sont sensibles à la casse. Pour plus d\'informations, reportez-vous aux sections correspondantes de la documentation de référence de l\'API. Vous y trouverez des instructions et des exemples clairs qui vous aideront à créer les requêtes et les corps de la demande avec la casse correcte.

Premiers pas avec les API de la Control Room

Toutes les demandes doivent inclure un en-tête X-Authorization avec le jeton d\'authentification JSON ou l\'en-tête Authorization avec un Bearer token pour les demandes adressées à la Control Room. Les sections suivantes fournissent des détails sur les points de terminaison, les méthodes, les ressources, les protocoles d\'authentification, les paramètres et les en-têtes des API de la Control Room disponibles, ainsi que des exemples de demandes et de réponses courantes.

Remarque : Le Bearer token est pris en charge à partir de la version Automation 360 v.27. Il n\'est pas pris en charge et est ignoré dans les versions précédentes. Vous devez obtenir le Bearer token à partir de nos services OAuth. Pour autoriser votre accès, utilisez X-Authorization (en utilisant l\'API d\'authentification) ou Authorization (en utilisant OAuth). Vous ne pouvez pas utiliser les deux dans la même API.
Vous pouvez utiliser la documentation Swagger de la Control Room pour visualiser et exécuter les API. Accédez à la documentation Swagger de la Control Room en utilisant le lien https://{control-room}/swagger/ et remplacez {control-room} par votre instance de Control Room. Les sections suivantes fournissent des informations utiles sur la manière de rédiger une demande API de la Control Room :

Politique de dépréciation de l\'API

Obsolescence de l\'API indique qu\'une API n\'est plus recommandée pour une utilisation mais qu\'elle est fonctionnelle. Les développeurs sont encouragés à migrer vers des versions plus récentes et prises en charge de l\'API. L\'API sera disponible jusqu\'à la date de fin de vie (EoL) et la version de sortie pour permettre une transition en douceur.

API EoL (Fin de Vie) indique la date et la version de publication à laquelle l\'API cessera de fonctionner et ne sera plus disponible à l\'utilisation. Les développeurs doivent avoir terminé leur migration vers les versions plus récentes et prises en charge de l\'API avant cette date.

Les scénarios suivants nécessitent la dépréciation des API:

  • Vulnérabilités de sécurité: Les anciennes versions de l\'API contiennent des vulnérabilités de sécurité connues qui ont été corrigées dans les versions plus récentes.
  • Dette technique: Les anciennes versions d\'API peuvent être construites sur des technologies, des approches ou des frameworks obsolètes qui ne sont plus pris en charge, rendant la maintenance ou les améliorations difficiles.
  • Performance : Les anciennes versions de l\'API ne sont pas optimisées pour les cas d\'utilisation modernes ou les augmentations d\'échelle, ce qui entraîne de mauvaises performances et des temps de réponse plus lents.
  • Expérience utilisateur : Les versions d\'API obsolètes contiennent des points de terminaison confus ou redondants qui peuvent rendre la navigation difficile pour les utilisateurs.

À partir de l\'annonce de la dépréciation, une API est disponible pendant au moins un an (quatre versions) pour vous donner suffisamment de temps pour passer à la version plus récente.

Remarque : Il peut y avoir des cas rares où une API doit être immédiatement supprimée en raison d\'un problème critique tel qu\'une vulnérabilité de sécurité critique. Dans de tels cas, nous ferons tout notre possible pour vous communiquer ce changement dès que possible.