Automation 360

API タスクリアルタイムエンドポイント

PDF としてダウンロード

フィードバック

コンテンツ

API タスクリアルタイムエンドポイント

PDF としてダウンロード

フィードバック

更新日 2024/04/17

API タスクリアルタイムエンドポイント

リアルタイムエンドポイントで API タスクを即座に呼び出します。API タスク実行 URL とトークンを生成し、API エンドポイントから API タスク実行を開始できます。

主なメリット

プログラム的デプロイ: お好みの API クライアントを使用して、リアルタイムでどこからでも API タスクを呼び出します。
応答時間: 低レイテンシーで、ほぼリアルタイムの応答速度を実現するように設計されており、ほとんど即座に (通常はミリ秒以内に) 応答することを目指しています。
処理:
- オートメーションはクラウドにロードされ、いつでもリクエストを受け付けることができます。これにより、迅速な処理と対応が可能になります。
- プレミアムライセンスではオートメーションが拡張され、クラウドリソースの大規模なプールにアクセスして API タスクの複数のインスタンスを実行できるため、並行性が高まり、より多くの API タスクリクエストを同時に処理できるようになります。
使用事例:
- チャットボットのようなインタラクティブな状況に最適
- リアルタイムの不正検知
- オンラインケース作成
- 即座の応答が重要な事例

前提条件

必ず API タスクを作成してください。API タスクの作成の詳細については、「API タスク (フォームの API タスク) を作成する」を参照してください。
API タスクをチェックインしている必要があります。API タスクのチェックインについての詳細は、「リポジトリに API タスクをチェックインする」を参照してください。

以下のサンプルコードスニペットでは、API タスクをリアルタイムでクラウドデバイスにデプロイする手順について説明しています。また、変数は、デプロイされたときに API タスクに渡すこともできます。

ステップ 1: API タスクリアルタイムエンドポイント: Control Room インスタンスへのアクセスを認証します。
ステップ 2: API タスクリアルタイムエンドポイント: 管理者は API タスクの割り当てを作成できます。
ステップ 3: API タスクリアルタイムエンドポイント: 管理者はすべての API タスクの割り当てをリストできます。
ステップ 4: API タスクリアルタイムエンドポイント: URL とトークンを生成して、API タスクをデプロイします。
ステップ 5: API タスクリアルタイムエンドポイント: 生成された一意の URL とトークンで API タスクを実行します。

認証

環境にアクセスするために認証します。一般的には、アクセストークンや API キーが含まれます。

POST https://{{ControlRoomURL}}v1/authentication

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

API タスクのリアルタイムエンドポイントと対話するには、2 種類の認証フローがあります。

1.Bot 開発者認証 (API タスク実行):

このフローにより、Bot 開発者は API タスク (API タスクリアルタイムエンドポイント) を実行するための URL とトークン (API タスクリアルタイムエンドポイント) を生成できます。

すべての API 呼び出しには、認証 API による認証トークン (JSON Web トークンを生成)、または OAuth サービスによるベアラートークンのいずれかが必要です。API で両方を同時に使用することはできません。

2.管理者認証 (API タスクの割り当て):

この認証は、管理者がクラウドで API タスクを割り当てる (「API タスクリアルタイムエンドポイント」) ために必要です。それにより、Bot 開発者が API タスクを実行できるようになります。

API タスクの割り当ての作成 (管理者)

注: API タスク割り当てを作成するには、管理者権限が必要です。

API タスクがチェックインされると、API タスクをクラウドに追加できます。この AP Iエンドポイントでは、API タスクをクラウドに追加し、API タスクを実行するためのリソースの割り当てを作成します。Control Room 内の API タスクの割り当ての詳細について説明した対応するセクションは「クラウドに API タスクを追加する」です。API タスクの割り当ては、API タスクが作成された後に実行されます。API タスクの作成の詳細については、「API タスク (フォームの API タスク) を作成する」を参照してください。

PUT https://{{ControlRoomURL}}orchestrator/v1/hotbot/config/create

リクエスト本文:

{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}

レスポンス:

{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}

リクエスト/レスポンスパラメーター


パラメーター	タイプ	必須	説明
fileId	Integer	はい	デプロイされるオートメーションの ID。
runAsUserOrNone	Integer	いいえ	API タスクの RunAsUser コンテキストを確立する apitaskrunner。apitaskrunner の詳細については、「API タスクの実行ユーザー (apitaskrunner)」を参照してください。注: この RunAsUser には、Bot Runner ライセンスは不要です。
concurrencyLimit	Integer	いいえ	指定されたリアルタイム (hotbot) リクエストに対して実行される同時実行の最大数。

(オプション) API タスクの割り当てのリスト (管理者)

注: API タスクの割り当てを一覧表示するには、管理者権限が必要です。

この API エンドポイントでは、Control Room 内のすべての API タスクの割り当てを一覧表示します。API タスク実行 URL とトークンの生成に進む前に、特定の API タスクが API タスクの割り当てリストに追加されているかどうかを確認できます。

POST https://orchestrator/v1/hotbot/config

リクエスト本文:

{
  "page": {
    "offset": 0,
    "length": 100
  }
}

リクエストパラメーター


パラメーター	タイプ	必須	説明
page	オブジェクト	いいえ	`object (PageRequest)` ページネーションルールでは、目的のページに基づいてフィルタリングできます。
offset	Integer	いいえ	ページ開始インデックス。
長さ	Integer	いいえ	ページの長さ。

レスポンス:

{
    "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
    }
}

レスポンスパラメーター


パラメーター	タイプ	説明
fileId	Integer	オートメーションの ID。
filePath	文字列	オートメーションのファイルパス
fileName	文字列	オートメーションのファイル名。
runAsUserOrNone	Integer	API タスクの RunAsUser コンテキストを確立する apitaskrunner。apitaskrunner の詳細については、「クラウドに API タスクを追加する」を参照してください。
concurrencyLimit	Integer	指定されたリアルタイム (hotbot) リクエストに対して実行される同時実行の最大数。

タスク実行 URL/トークンの生成

この API エンドポイントでは、タスクの実行 URL とトークンを生成します。これらは API タスクにデプロイできます。

POST https://orchestrator/v1/hotbot/config/accessdetails

リクエスト本文:

{
  "botRepositoryPath": [
    "Automation Anywhere\\Bots\\My-API-Task"
  ]
}

リクエストパラメーター


パラメーター	タイプ	必須	説明
botRepositoryPath	文字列	はい	API タスクのリポジトリパス。

レスポンス:

{
  "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": {
  }
}

レスポンスパラメーター


パラメーター	タイプ	説明
URL	文字列	URL - これは、API タスクをデプロイするための次のリクエストのコンテナエンドポイントです。
X-Authorization	文字列	ヘッダーに `X-Authorization` として表示する必要があるトークンが含まれます。

注:

API タスクの実行に必要なヘッダーと API タスク実行 URL を生成したら、生成された URL 経由でデプロイリクエストを送信できます。入力を指定する場合、オートメーションがこれらのマッピングされた値を正常に受信することを確認します。そのオートメーション用の変数は入力としてマークされている必要があります。さらに、オートメーションの変数名は、リクエスト本文にマッピングされる値と一致しなければなりません。

API タスクの実行

生成された一意の URL とトークンで API タスクを実行します。

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

リクエスト本文:

{
   "botInput":{
      "iStrZipCode":{
         "type":"STRING",
         "string":"76131"
      }
   }
}

リクエストパラメーター


パラメーター	タイプ	必須	説明
botInput オブジェクト
タイプ	任意	いいえ	デフォルトでは `STRING` です。タイプに指定できる値は次のとおりです。`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.`

レスポンス:

{
   "hotBotResult":{
      "botOutput":{
         "State":{
            "type":"STRING",
            "string":"California"
         },
         "Place":{
            "type":"STRING",
            "string":"San Jose"
         }
      }
   }
}

レスポンスパラメーター