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:
  • Ab Automation 360 v.33 gilt für die Authentifizierungs-APIs: POST v1/authentication und POST v1/authentication/token werden eingestellt und werden nicht mehr funktionieren. Um einen unterbrechungsfreien Zugriff zu gewährleisten, aktualisieren Sie Ihre Anwendungen, sodass sie die v2-Versionen der Authentifizierungs-APIs verwenden: POST v2/authentication und POST v2/authentication/token.
  • Ab Automation 360 v.33 gilt für die Nutzerverwaltungs-APIs: v1/usermanagement werden eingestellt und funktionieren nicht mehr. Um einen unterbrechungsfreien Zugriff zu gewährleisten, aktualisieren Sie Ihre Anwendungen, sodass sie die v2-Versionen der Benutzerverwaltungs-APIs verwenden v2/usermanagement.

Sie können alle Control Room-API-Module und die zugehörigen Endpunkte in der folgenden API-Referenztabelle anzeigen und zu ihnen navigieren:

Versionen Endpunkte
v1
v2
v3
v4
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 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.
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:Im folgenden Video erfahren Sie, wie Sie Control Room-APIs in Swagger und Postman testen können: