Control Room-APIs

Der Automation Anywhere-Control Room bietet APIs, mit denen Sie anpassen können, wie Sie (und Ihre Automatisierungen) mit Automation Anywhere interagieren.

Wichtig:
  • Aus Automation 360 v.34; die folgenden WLM-API-Endpunkte sind veraltet und sollen zusammen mit der Veröffentlichung von v.38 eingestellt werden (EoL):
    • POST /v3/wlm/workitemmodel
    • GET /v3/wlm/workitemmodels/{id}
    • GET /v3/wlm/queues/{id}
    • POST /v3/wlm/queues/{id}/consumers
    • 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}
    Ersetzen Sie die obigen API-Endpunkte durch die folgenden API-Endpunkte:
    • POST /v4/wlm/workitemmodel
    • GET /v4/wlm/workitemmodels/{id}
    • GET /v4/wlm/queues/{id}
    • POST /v4/wlm/queues/{id}/consumers
    • 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}
  • Ab Automation 360 v.34 sind die Bot Scheduler API-Endpunkte: /v1/schedule/automations veraltet und werden ersetzt durch /v2/schedule/automations. Die Version v1 soll zusammen mit der Veröffentlichung von v.38 eingestellt werden (EoL).

Sie können alle Control Room-API-Module und die zugehörigen Endpunkte in den folgenden API-Referenzabschnitten anzeigen und zu ihnen navigieren.

Die verschiedenen API-Versionen unten stellen unterschiedliche Iterationen von APIs im Laufe der Zeit dar. Im Zuge der Weiterentwicklung einer API werden neue Funktionen oder Verbesserungen eingeführt. Um diese Änderungen zu verwalten und die Kompatibilität mit vorhandenen Anwendungen aufrechtzuerhalten, verwenden Entwickler die Versionierung.

v1-Endpunkte

Module Beschreibung
Authentifizierungs-API Verwenden Sie die Authentifizierungs-APIs v1, um die Authentizität und Integrität von JSON Web Tokens (JWTs) zu überprüfen und aktive Nutzersitzungen zu beenden.
Audit-API Verwenden Sie die Audit-APIs, um Audit-Protokolldaten aus Ihrem Control Room abzurufen.
Geräte-API Verwenden Sie die Geräte-APIs, um alle verfügbaren Nutzer mit Lizenzen für unbeaufsichtigte Bot-Runner zu identifizieren oder Nutzer nach Namen zu filtern.
Automatisierungs-API Veraltet Verwenden Sie die v1 APIs für Bot-Zeitplanung (Automatisierungs-APIs), um geplante Automatisierungen zu erstellen, zu aktualisieren, zu löschen und Details dazu zurückzugeben.
Auslöser-API Verwenden Sie die Trigger-APIs, um Trigger Benutzern oder Rollen für einen Beaufsichtigten Bot Runner-Benutzer zuzuordnen. Sie können auch Ereignisauslöser erstellen und löschen.
API-Aufgabe Ausführungs-API Verwenden Sie die APIs für die API-Ausgabenausführung, um eine Ausführungs-URL für die API Aufgabe zusammen mit einem Token zum Starten der Ausführung einer API-Aufgabe über einen API-Endpunkt zu generieren.
API zur Richtlinienverwaltung Verwenden Sie die Richtlinienverwaltungs-APIs, um Codeanalyse, Richtlinien und Regeln innerhalb des Control Room zu verwalten.
AI Agent Studio API Verwenden Sie die AI Agent Studio APIs, um benutzerdefinierte Modellverbindungen-Modelle zu definieren und eine Verbindung mit diesen herzustellen. Sie können auch die benutzerdefinierten Modellverbindungen abrufen und löschen.

v2-Endpunkte

Module Beschreibung
Authentifizierungs-API Verwenden Sie die Authentifizierungs-APIs v2, um JSON Web Tokens (JWT) zu generieren und zu aktualisieren, die für die Autorisierung in allen Enterprise Control Room-APIs erforderlich sind.
API für die Nutzerverwaltung Verwenden Sie die APIs für die Nutzerverwaltung, um Rollen und Nutzer in Ihrem Control Room anzuzeigen und zu löschen.
Credential Vault-API Verwenden Sie die Credential Vault-APIs, um Anmeldedaten, Attributwerte für Anmeldedaten, Locker und Schlüssel zu erstellen, abzurufen, zu aktualisieren und zu löschen.
Orchestrator-API für Bot-Ausführung Verwenden Sie die Orchestrator-API v2 für Bot-Ausführung, um Geräte zu überwachen.
API für die Repository-Verwaltung Verwenden Sie die APIs für die Repository-Verwaltung, um bestimmte Aufgaben für Objekte (Bots, Ordner und Dateien) auszuführen, für die Sie im Control Room über eine Zugriffsberechtigung verfügen.
BotInsight-API Verwenden Sie die Bot Insight-APIs, um in Echtzeit auf geschäftliche Erkenntnisse und Leistungsdaten der digitalen Belegschaft zuzugreifen und auf Inhaltsebene Produktivitätsdaten von den bereitgestellten Automatisierungen zu nutzen.
BLM-API Verwenden Sie die Bot Lifecycle Management-(BLM)-APIs, um Bots mit abhängigen Dateien und Befehlspaketen für ein umfassendes Lifecycle Management für Automatisierungen zu importieren und zu exportieren.
Gerätepool-API Verwenden Sie die Gerätepool-APIs, um Gerätepools zu erstellen, aufzulisten, zu aktualisieren und zu löschen.
Lizenz-API Verwenden Sie die Lizenz-APIs, um Control Room-Lizenzdetails abzurufen und den Control Room nach der Neuzuweisung oder Verlängerung der Lizenz manuell mit dem Lizenzserver zu synchronisieren.
Process Composer-API Verwenden Sie die Process Composer-APIs, um aus Prozessen eine neue Anforderung zu erstellen, das ursprüngliche Formular abzurufen und Anforderungen per Referenz-ID auszuführen.
Automatisierungs-API Verwenden Sie die v2 APIs für Bot-Zeitplanung (Automatisierungs-APIs), um geplante Automatisierungen zu erstellen, zu aktualisieren, zu löschen und Details dazu zurückzugeben.
API zur Richtlinienverwaltung Verwenden Sie die v2-Richtlinienverwaltungs-APIs, um Codeanalyse, Richtlinien und Regeln innerhalb von Control Room zu verwalten.

v3-Endpunkte

Module Beschreibung
Bot-Bereitstellungs-API Verwenden Sie die Bot-Bereitstellungs-API v3, um Bots aus dem öffentlichen Arbeitsbereich auf Bot Runner-Geräten bereitzustellen.
Workload-Management-API Verwenden Sie die v3 Workload Management-(WLM)-APIs, um Aufgabenelementmodelle, Warteschlangen, Aufgabenelemente und Automatisierungen in Ihrem Control Room programmgesteuert zu verwalten und zu erstellen.
Migrations-API (Bot-Migration) Verwenden Sie die Migrations-APIs v3, um TaskBots und MetaBots, die in den Enterprise-Clientversionen Enterprise 11 und Enterprise 10 erstellt wurden, zu Automation 360 zu migrieren.
Orchestrator-API für Bot-Ausführung Verwenden Sie die Orchestrator-API für Bot-Ausführung v3, um den Fortschritt der Automatisierungsaktivität zu überwachen.

v4-Endpunkte

Module Beschreibung
Bot-Bereitstellungs-API (V4) Verwenden Sie die v4 Bot Deploy API, um Bots aus dem öffentlichen Arbeitsbereich auf Bot Runner-Geräte bereitzustellen.
Workload-Management-API Verwenden Sie die v4 Workload Management-(WLM)-APIs, um Aufgabenelementmodelle, Warteschlangen, Aufgabenelemente und Automatisierungen in Ihrem Control Room programmgesteuert zu verwalten und zu erstellen.
Migrations-API (Bot-Migration) Verwenden Sie die Migrations-APIs v4, um TaskBots und MetaBots, die in den Enterprise-Clientversionen Enterprise 11 und Enterprise 10 erstellt wurden, zu Automation 360 zu migrieren.
Anmerkung: Um Fehler zu vermeiden und eine reibungslose Verarbeitung Ihrer Anforderungen zu gewährleisten, achten Sie darauf, dass bei allen JSON-Parameternamen die Groß- und Kleinschreibung beachtet wird. Weitere Informationen finden Sie in den entsprechenden Abschnitten der API-Referenzdokumentation. Dort finden Sie klare Richtlinien und Beispiele, die Ihnen dabei helfen, Ihre Abfragen und Anforderungstexte mit der richtigen Groß- und Kleinschreibung zu erstellen.

Erste Schritte mit Control Room-APIs

Alle Anforderungen an den müssen einen X-Autorisierung-Header mit dem JSON-Authentifizierungstoken oder einen AutorisierungControl Room-Header mit einem Bearer-Token enthalten. In den folgenden Abschnitten finden Sie Einzelheiten zu den verfügbaren Endpunkten, Methoden, Ressourcen, Authentifizierungsprotokollen, Parametern und Headern der Control Room-APIs sowie Beispiele für gängige Anfragen und Antworten.

Anmerkung: Das Bearer-Token wird ab Automation 360 v.27 unterstützt. Es wird in früheren Versionen nicht unterstützt und ignoriert. Sie erhalten das Bearer-Token von unseren OAuth-Diensten. Verwenden Sie entweder X-Autorisierung (mit der Authentifizierungs-API) oder Autorisierung (mit OAuth), um Ihren Zugriff zu autorisieren. Sie können nicht beide in derselben API verwenden.
Sie können die Control Room-Swagger-Dokumentation verwenden, um die APIs anzuzeigen und auszuführen. Greifen Sie auf die Control Room-Swagger-Dokumentation zu, indem Sie den Link https://{control-room}/swagger/ verwenden und {control-room} durch Ihre Control Room-Instanz ersetzen. Die folgenden Abschnitte enthalten hilfreiche Informationen zum Schreiben einer Control Room-API-Anfrage:

Richtlinie zur Einstellung von APIs

Eine veraltete API bedeutet, dass die Verwendung einer API nicht mehr empfohlen wird, sie aber noch funktioniert. Entwickler werden ermutigt, auf neuere, unterstützte Versionen der API zu migrieren. Die API wird bis zum End-of-Life-Datum (EoL) und der Release-Version verfügbar sein, um einen reibungslosen Übergang zu ermöglichen.

API EoL (End of Life) gibt das Datum und die Release-Version an, an dem die API nicht mehr funktioniert und nicht mehr verwendet werden kann. Entwickler sollten ihre Migration auf die neueren, unterstützten Versionen der API vor diesem Datum abgeschlossen haben.

Die folgenden Szenarien können die Außerkraftsetzung von APIs erfordern:

  • Sicherheitslücken: Ältere API-Versionen enthalten bekannte Sicherheitslücken, die in neueren Versionen behoben wurden.
  • Technische Schulden: Ältere API-Versionen können auf veralteten Technologien, Ansätzen oder Frameworks basieren, die nicht mehr unterstützt werden, was Wartung oder Erweiterungen erschwert.
  • Performance: Ältere API-Versionen sind nicht für moderne Anwendungsfälle oder Skalierungssteigerungen optimiert, was zu schlechter Performance und langsameren Reaktionszeiten führt.
  • Benutzererlebnis: Veraltete API-Versionen enthalten verwirrende oder redundante Endpunkte, die es den Nutzern erschweren können, sich zurechtzufinden.

APIs werden für einen Mindestzeitraum von zwei Jahren unterstützt. Nach zwei Jahren kann eine Außerkraftsetzung einer API angekündigt werden, wobei die API mindestens ein weiteres Jahr lang (vier Versionen) verfügbar ist, um Ihnen ausreichend Zeit zu geben, auf die neuere Version umzusteigen.

Anmerkung: Die obige Richtlinie gilt nicht für die Außerkraftsetzung aufgrund von Sicherheitslücken bei öffentlichen APIs. In solchen Fällen ist sofortiges Handeln erforderlich, um Risiken zu mindern, und wir werden uns bemühen, Ihnen diese Änderung so schnell wie möglich mitzuteilen.