Control Room の API

Automation Anywhere Control Room は、ユーザー (およびユーザーのオートメーション) が Automation Anywhere とやり取りする方法をカスタマイズできる API を提供しています。

Control Room API を使用して次の操作を実行できます。

Bot のデプロイの管理
Credential Vault での資格情報の作成と管理
ユーザーアカウントとロールの作成と管理
キューを作成して管理

Control Room API の使用を開始

Control Room に送信されるすべてのリクエストには、X-Authorization ヘッダーと JSON 認証トークン、または Authorization ヘッダーとベアラートークンが含まれている必要があります。以下のセクションでは、Control Room API で利用できるエンドポイント、メソッド、リソース、認証プロトコル、パラメーター、ヘッダーについて詳細に説明し、一般的なリクエストと応答の例を示します。

注: ベアラートークンは、Automation 360 v.27 リリース以降でサポートされています。それ以前の全リリースで、ベアラートークンはサポートされず、無視されます。ベアラートークンは OAuth サービスから取得する必要があります。アクセスを認証するには、X-Authorization (Authentication API を使用) または Authorization (OAuth を使用) のいずれかを使用します。同じ API で両方を使用することはできません。

Control Room は、いくつかの REST API クライアントをサポートしています。Control Room Swagger を使用して、API の表示と実行ができます。https://{control-room}/swagger/ リンクを使用し、{control-room} をお使いの Control Room インスタンスに置き換えて、Control Room Swagger にアクセスします。Postman で Control Room API を試用するには、Postman をダウンロードしてインストールし、[Postman collection] をクリックして Control Room API コレクションをダウンロードします。以下のセクションでは、Control Room API リクエストの記述方法について役立つ情報を提供します。

Swagger と Postman で Control Room API をテストする方法については、次のビデオをご覧ください。

API モジュールの redoc ビュー

API モジュールを redoc ビューで表示できるようになりました。このビューは、直感的なインターフェースを提供し、包括的な説明と再利用できる関連コードサンプルを含む Control Room API の使用に関する情報を簡単に見つけることができます。

レイアウトは、API 情報を以下のペインに分類する 3 つのパネル表示に更新されます。

左側のペインの目次。
中央のペインの紹介と説明。
右側のペインの再利用可能なコードサンプル。

このビューには、各エンドポイントの詳細と使用例が含まれています。

<span>API redoc ドキュメント</span>