使用自动注册 API
- Updated: 2024/11/20
使用自动注册 API 自动注册并将您的设备连接到 Control Room。
该 API 使用 autoregistration.properties
文件中的通用 Control Room 注册令牌,在指定的 Control Room URL 中注册设备。 如果Control Room URL 在autoregistration.properties
文件中不可用,则无法自动注册设备。 您的本地系统中必须有 autoregistration.properties
文件,并且在注册完成后不得删除该文件。
注: 要通过命令行或 API 注册设备,您必须设置 AA_DELAY_REGISTRATION_UNTIL_LOGIN MSI 参数。 您可以在 Bot Agent MSI 文件或
autoregistration.properties
文件中启用此参数。 有关更多信息,请参阅 批量安装 机器人代理。 您还可以在批量安装主题中查看示例 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 | 数字 | 安装 机器人代理 的设备的唯一标识符。 |
crUrl | 字符串 |
设备自动注册的 Control Room URL。 |
userName | 字符串 |
设备默认为关联设备使用的用户名。 |
安装类型 | 字符串 | 执行的安装类型。 |
crSwitchAllowed | 字符串 | 指示设备是否可以在不同的 Control Room 上注册。 |