Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

Enterprise Control Room-API zur Authentifizierung

  • Aktualisiert: 5/24/2019
    • 11.3.x
    • Erkunden
    • Enterprise
    • API-Dokumente

Enterprise Control Room-API zur Authentifizierung

Vor allen APIs steht eine Authentifizierungs-API, in der sich der Nutzer der Drittanbieter-Anwendung, die den Aufruf veranlasst hat, authentifizieren muss, damit er die späteren APIs verwenden darf.

Enterprise Control Room v.11.x legt öffentliche APIs offen, damit die Control Room-Daten manipuliert und Bots aus einem externen System bereitgestellt werden können. Damit können Anwendungen von Drittanbietern RPA nutzen, Bots orchestrieren und RPA-Daten ereignisabhängig verwalten. Erstellen Sie beispielsweise einen Automation Anywhere-Nutzer, sobald ein Nutzer in einem SAP-System angelegt wird, oder aktualisieren Sie die Anmeldedaten in Automation Anywhere, sobald ein Kennwort im Domänencontroller routinemäßig geändert wird.

Authentifizierungs-API

API: v1/authentication

Wenn die Enterprise Control Room-URL https://<your-control-room-url> lautet, ist die API https://<your-control-room-url>/v1/authentication.

Die API verwendet zwei obligatorische Parameter und einen optionalen Parameter als Eingabe im JSON-Format:

  • username des Automation Anywhere-Nutzers.
  • password des Automation Anywhere-Nutzers.
  • Der apiKey wird nur benötigt, wenn der Enterprise Control Room für Single Sign On (SSO) konfiguriert ist. Entfernen Sie dieses Feld, wenn Ihr Enterprise Control Room SSO nicht verwendet.
{ "username": "string", "password": "string", "apiKey": "string" } 

Beispiel:

  • Der Automation Anywhere-Nutzername ist mike_williams.
  • Das Automation Anywhere-Kennwort lautet abc123.
Das JSON-Anforderungsformat, das mit einem Enterprise Control Roomverwendet wird, für das SSO nicht aktiviert ist, lautet wie folgt:
{ "username": "mike_williams", "password": "abc123" } 

Wenn die Authentifizierung erfolgreich ist, stellt der Enterprise Control Room ein Authentifizierungs-Token aus, das als Header-Information an die anderen Enterprise Control Room-APIs weitergegeben werden muss.

Anmerkung: Das Authentifizierungs-Token ist ab dem Zeitpunkt der Ausstellung nur 15 Minuten lang gültig.

Antwortcodes der Authentifizierungs-API

Http-Statuscode Antwort Beschreibung
200
{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJ1c2VyIjoiMSIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Qvd2ViY3 JzdmMvIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdC93ZWJjcnN2Yy8iLCJle HAiOjE0OTUwOTAwOTksIm5iZiI6MTQ5NTA4OTE5OX0.qPPhpti0j7 LGAmWkj3XFymFfJXzA1P4zPehIjVYfulc" }
Bei einer erfolgreichen Authentifizierung wird ein Token zurückgegeben.
401
{ "message": "Invalid credentials." }
  • Das Kennwort ist ungültig.
  • Der Nutzer existiert nicht.
  • Die Active Directory (AD)-Authentifizierungsanmeldedaten sind ungültig.
401
{ "message": "Verify your email by clicking on the email verification link. This is mandatory as you will be able to login post verification only." }
Die E-Mail-Benachrichtigung ist aktiviert, und der Nutzer hat seine E-Mail-Adresse nicht überprüft.
402
{ "message": "License expired." }
Mindestens eine Lizenz ist abgelaufen.
403
 { "message": "Your account is not activated. Contact the admin." }
Das Konto des Nutzers ist deaktiviert.
Feedback senden