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.

Mit Control Room-APIs können Sie:

Bot-Einsätze verwalten
Berechtigungsnachweise in Credential Vault erstellen und verwalten
Nutzerkonten und Rollen erstellen und verwalten
Warteschlangen erstellen und verwalten

Erste Schritte mit Control Room-APIs

Alle Anforderungen an den Control Room müssen einen X-Autorisierung-Header mit dem JSON-Authentifizierungstoken oder einen Autorisierung-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.

Der Control Room unterstützt mehrere API-Clients. So können Sie die Control Room-APIs erkunden: Laden Sie Postman herunter und installieren Sie die Anwendung. Klicken Sie dann auf https://www.postman.com/collections/bb5cd3541d29e192cd43, um die Sammlung von Control Room-APIs herunterzuladen. Die folgenden Abschnitte enthalten hilfreiche Informationen zum Schreiben einer Control Room-API-Anfrage:

Bei einigen APIs müssen Sie die Ergebnisse filtern, paginieren und sortieren, um die gewünschte Ausgabe zu erhalten. Weitere Informationen zum Filtern, Paginieren und Sortieren finden Sie unter Filtern, Paginieren und Sortieren.
Die API-Antwortcodes in den Antworten sind im Abschnitt API-Antwortcodes beschrieben.
Automation 360 und Enterprise 11-APIs vergleichen vergleicht die APIs von Enterprise 11 und Automation 360.

Im folgenden Video erfahren Sie, wie Sie Control Room-APIs in Swagger und Postman testen können:

Redoc-Ansicht für API-Module

Sie können API-Module jetzt in einer Redoc-Ansicht anzeigen. Diese Ansicht bietet eine intuitive Schnittstelle, auf der Sie leicht Informationen über die Verwendung der Control Room-APIs mit umfassenden Beschreibungen und relevanten Code-Beispielen finden, die Sie wiederverwenden können.

Das Layout wird zu einer Ansicht mit drei Feldern aktualisiert, in der die API-Informationen in die folgenden Bereiche unterteilt sind:

Inhaltsverzeichnis im linken Fensterbereich.
Einleitung und Beschreibungen im zentralen Bereich.
Wiederverwendbare Code-Beispiele im rechten Fensterbereich.

Diese Ansicht enthält Details zu den einzelnen Endpunkten und Beispiele für ihre Verwendung.

<span>API-Redoc-Dokumentation</span>