API-Aufgabe-Echtzeit-Endpunkt

Sofortiges Aufrufen von API-Aufgaben mit einem Echtzeit-Endpunkt. Sie können eine API-Aufgaben-Ausführungs-URL zusammen mit einem Token generieren, um eine API-Aufgaben-Ausführung über einen API-Endpunkt zu starten.

Wichtigste Vorteile

  • Programmatische Bereitstellung: Rufen Sie die API-Aufgabe von überall in Echtzeit mit Ihrem bevorzugten API-Client auf.
  • Reaktionszeit: Entwickelt für niedrige Latenzzeiten mit Antwortraten nahezu in Echtzeit, mit dem Ziel, Antworten fast sofort zu liefern (normalerweise innerhalb von Millisekunden).
  • Verarbeitung:
    • Die Automatisierungen werden in die Cloud geladen und sind jederzeit bereit, Anforderungen anzunehmen. Dies ermöglicht eine schnelle Bearbeitung und Reaktion.
    • Mit der Premium-Lizenz können Sie Ihre Automatisierung skalieren und auf einen größeren Pool von Cloud-Ressourcen zugreifen, die mehrere Instanzen Ihrer API-Aufgabe ausführen können. Das erhöht die Gleichzeitigkeit und ermöglicht es Ihnen, mehr API-Aufgabe-Anforderungen gleichzeitig zu bearbeiten.
  • Anwendungsfälle:
    • Ideal für interaktive Situationen wie Chatbots
    • Betrugserkennung in Echtzeit
    • Online-Fallerstellungen
    • oder jeder Anwendungsfall, bei dem eine sofortige Reaktion entscheidend ist

Voraussetzungen

Die folgenden Codebeispiele zeigen Ihnen, wie Sie eine API-Aufgabe in Echtzeit auf einem Cloud-Gerät bereitstellen können. Sie können auch Variablen an API-Aufgaben weiterleiten, wenn sie bereitgestellt werden.

Schritt 1: API-Aufgabe-Echtzeit-Endpunkt
Authentifizieren Sie den Zugang zu Ihrer Control Room-Instanz.
Schritt 2: API-Aufgabe-Echtzeit-Endpunkt
Ein Administrator kann eine API-Aufgabe-Zuordnung erstellen.
Schritt 3: API-Aufgabe-Echtzeit-Endpunkt
Ein Administrator kann alle API-Aufgabe-Zuordnungen auflisten.
Schritt 4: API-Aufgabe-Echtzeit-Endpunkt
Generieren Sie die URL und das Token für die Bereitstellung Ihrer API-Aufgabe.
Schritt 5: API-Aufgabe-Echtzeit-Endpunkt
Führen Sie Ihre API-Aufgabe mit der eindeutigen URL aus, die zusammen mit dem Token generiert wurde.

Authentifizieren

Authentifizieren Sie sich, um Zugang zu Ihrer Umgebung zu erhalten. Dabei handelt es sich in der Regel um Zugriffstoken oder API-Schlüssel.

POST https://{{ControlRoomURL}}v1/authentication
Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

Für die Interaktion mit dem Echtzeit-Endpunkt der API-Aufgabe gibt es zwei verschiedene Authentifizierungsabläufe:

1. Bot-Entwickler-Authentifizierung (API-Aufgaben-Ausführung):

Dieser Ablauf ermöglicht es Bot-Entwicklern, eine URL und ein Token (API-Aufgabe-Echtzeit-Endpunkt) für die Ausführung einer API-Aufgabe (API-Aufgabe-Echtzeit-Endpunkt) zu generieren.

Alle API-Aufrufe müssen entweder ein Authentifizierungs-Token der Authentifizierungs-API (generiert JSON-Web-Token) oder ein Bearer-Token von OAuth-Diensten enthalten. Sie können nicht beide zusammen in einer API verwenden.

2. Administrator-Authentifizierung (API-Aufgabe-Zuweisung):

Diese Authentifizierung ist erforderlich, damit Administratoren die API-Aufgabe in der Cloud zuweisen (API-Aufgabe-Echtzeit-Endpunkt) können, damit ein Bot-Entwickler die API-Aufgabe ausführen kann.

Erstellen einer API-Aufgabe-Zuordnung (Admin)

Anmerkung: Sie benötigen Administratorrechte, um eine API-Aufgabe-Zuordnung zu erstellen.

Nachdem eine API-Aufgabe eingecheckt wurde, können Sie die API-Aufgabe zur Cloud hinzufügen. Dieser API-Endpunkt fügt die API-Aufgabe zur Cloud hinzu und erstellt eine Ressourcenzuweisung für die Ausführung Ihrer API-Aufgabe. Der entsprechende Abschnitt, in dem die API-Aufgabe-Zuordnung innerhalb des Control Room angegeben ist, lautet Hinzufügen einer API-Aufgabe zur Cloud. Die API-Aufgabe-Zuordnung erfolgt, nachdem eine API-Aufgabe erstellt wurde. Weitere Informationen zur Erstellung von API-Aufgabes finden Sie unter Erstellen einer API-Aufgabe (API-Aufgabe in Formular).

PUT https://{{ControlRoomURL}}orchestrator/v1/hotbot/config/create
Anforderungstext:
{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}
Antwort:
{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}
Anfrage/Antwort-Parameter
Parameter Typ Erforderlich Beschreibung
fileId Integer Ja

ID der Automatisierung, die bereitgestellt werden soll.
runAsUserOrNone Integer Nein Der apitaskrunner zum Einrichten des RunAsUser-Kontextes für API-Aufgaben. Weitere Informationen zu apitaskrunner finden Sie unter RunAsUser für API-Task (apitaskrunner).
Anmerkung: Für diesen RunAsUser ist keine Bot-Runner-Lizenz erforderlich.
concurrencyLimit Integer Nein Maximale Anzahl der Gleichzeitigkeiten, die für eine bestimmte Echtzeit-Anfrage (Hotbot) ausgeführt werden.

(Optional) Auflisten der API-Aufgaben-Zuordnung (Administrator)

Anmerkung: Sie benötigen Administratorrechte, um die API-Aufgaben-Zuordnung aufzulisten.

Dieser API-Endpunkt listet alle API-Aufgaben-Zuordnungen innerhalb Ihres Control Room auf. Sie können bestätigen, ob eine bestimmte API-Aufgabe zur API-Aufgabe-Zuordnungsliste hinzugefügt wurde, bevor Sie mit der Generierung der URL für die API-Aufgabenausführung mit Token fortfahren.

POST https://orchestrator/v1/hotbot/config
Anforderungstext:
{
  "page": {
    "offset": 0,
    "length": 100
  }
}
Anforderungsparameter
Parameter Typ Erforderlich Beschreibung
page Objekt Nein object (PageRequest)

Paginierungsregeln, die es Ihnen ermöglichen, nach der gewünschten Seite zu filtern
offset Integer Nein Seiten-Startindex.
Länge Integer Nein Seitenlänge.
Antwort:
{
    "list": [
        {
            "fileId": "149",
            "filePath": "Automation Anywhere\\Bots\\Zip Code API Task",
            "fileName": "Zip Code API Task",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 1
        },
        {
            "fileId": "180",
            "filePath": "Automation Anywhere\\Bots\\API_task_String 01 1708025672.bot",
            "fileName": "API_task_String 01 1708025672.bot",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 3
        },
        {
            "fileId": "184",
            "filePath": "Automation Anywhere\\Bots\\API_task_Rest 01 1708026445.bot",
            "fileName": "API_task_Rest 01 1708026445.bot",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 5
        }
    ],
    "page": {
        "offset": 0,
        "total": 3,
        "totalFilter": 3
    }
}
Antwortparameter
Parameter Typ Beschreibung
fileId Integer

ID der Automationen.
filePath Zeichenfolge Der Dateipfad der Automatisierungen
fileName Zeichenfolge Der Dateiname der Automatisierung.
runAsUserOrNone Integer Der apitaskrunner zum Einrichten des RunAsUser-Kontextes für API-Aufgaben. Weitere Informationen zu apitaskrunner finden Sie unter Hinzufügen einer API-Aufgabe zur Cloud.
concurrencyLimit Integer Maximale Anzahl der Gleichzeitigkeiten, die für eine bestimmte Echtzeit-Anfrage (Hotbot) ausgeführt werden.

URL/Token für die Aufgabenausführung generieren

Dieser API-Endpunkt generiert eine URL für die Aufgabenausführung und ein Token, mit dem Sie eine API-Aufgabe bereitstellen können.

POST https://orchestrator/v1/hotbot/config/accessdetails
Anforderungstext:
{
  "botRepositoryPath": [
    "Automation Anywhere\\Bots\\My-API-Task"
  ]
}
Anforderungsparameter
Parameter Typ Erforderlich Beschreibung
botRepositoryPath Zeichenfolge Ja Repository-Pfad der API-Aufgabe
Antwort:
{
  "accessDetails": {
    "Automation Anywhere\\Bots\\My-API-Task": {
      "url": "https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/execute",
      "headers": {
        "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ"
      }
    }
  },
  "errors": {
  }
}
Antwortparameter
Parameter Typ Beschreibung
URL Zeichenfolge

URL – Dies ist der Container-Endpunkt für Ihre nächste Anforderung zur Bereitstellung Ihrer API-Aufgabe.
X-Authorization Zeichenfolge Enthält das Token, das Sie in den Kopfzeilen als X-Authorization angeben müssen.
Anmerkung:

Sobald Sie die Ausführungs-URL der API-Aufgabe sowie die erforderlichen Kopfzeilen zur Ausführung der API-Aufgabe generiert haben, können Sie eine Bereitstellungsanforderung über die generierte URL senden. Wenn Sie Eingaben angeben, stellen Sie sicher, dass die Variable für den Bot als Eingabe markiert ist, damit die Automatisierung diese zugeordneten Werte erfolgreich empfangen kann. Darüber hinaus muss der Name der Variablen in der Automatisierung mit dem Wert übereinstimmen, der im Anforderungstext zugeordnet wird.

API-Aufgabe ausführen

Führen Sie Ihre API-Aufgabe mit der eindeutigen URL aus, die zusammen mit dem Token generiert wurde.

POST https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/execute
Header: X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ
Anforderungstext:
{
   "botInput":{
      "iStrZipCode":{
         "type":"STRING",
         "string":"76131"
      }
   }
}
Anforderungsparameter
Parameter Typ Erforderlich Beschreibung
botInput-Objekt
type Beliebig Nein Standardmäßig ist es STRING. Mögliche Werte für den Typ sind beispielsweise STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY, and WORKITEM.
Antwort:
{
   "hotBotResult":{
      "botOutput":{
         "State":{
            "type":"STRING",
            "string":"California"
         },
         "Place":{
            "type":"STRING",
            "string":"San Jose"
         }
      }
   }
}
Antwortparameter
Parameter Typ Beschreibung
hotBotResult Objekt

Objekt, das die Ausgabe der API-Aufgabe enthält.