自動登録 API の使用
- 更新日 2024/01/10
自動登録 API の使用
Auto registration API を使用して、デバイスを自動的に登録し、Control Room に接続します。
この API は、autoregistration.properties
ファイルから取得した汎用登録トークンを使用して、指定された Control Room URL 内のデバイスを登録します。Control Room の URL が autoregistration.properties
ファイルに存在しない場合、デバイスを自動登録することはできません。autoregistration.properties
ファイルはローカル システムに存在している必要があります。このファイルは登録が完了した後で削除しないでください。
注: コマンド ラインや API でデバイスを登録するには、AA_DELAY_REGISTRATION_UNTIL_LOGIN MSI パラメーターを設定する必要があります。このパラメーターは、Bot Agent MSI ファイルまたは
autoregistration.properties
ファイルで有効にすることができます。詳細については、「デバイスの Bot エージェントの一括インストール」を参照してください。一括インストールのトピックでは、autoregistration.properties
ファイルのサンプルも確認できます。リクエスト
POST http://127.0.0.1:22113/v1/registration/auto
リクエスト本文:
{ "url": "https://{controlroom url}", "userName": "dpcreator" }
リクエスト パラメーター
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
URL | 文字列 | はい |
Control Room URL を指定して、デバイスを自動登録します。 |
userName | 文字列 | いいえ |
Control Room ユーザーを指定して、デバイスをデフォルト デバイスとして関連付けます。 |
レスポンス
{ "result": "REGISTERED", "deviceId": "11", "crUrl": "control_room_url", "userName": "dpcreator" "installationType": "SYSTEM_WIDE", "crSwitchAllowed": "false", }
レスポンス パラメーター
パラメーター | タイプ | 説明 |
---|---|---|
結果 | 文字列 | デバイス登録のステータスです。 |
deviceId | 数字 | Bot エージェントがインストールされているデバイスの一意の ID です。 |
crUrl | 文字列 |
デバイスが自動登録される Control Room の URL です。 |
userName | 文字列 |
デバイスがデフォルト デバイスとして関連付けられているユーザー名です。 |
installationType | 文字列 | 実行されるインストールのタイプです。 |
crSwitchAllowed | 文字列 | デバイスが別の Control Room に登録できるかどうかを示します。 |