跳转至

设备声明

用例描述

作为租户，我想通过脚本或 UI 预先配置我的设备。我的客户直接从我这里或通过分销商购买设备。我希望我的客户在物理访问设备后，可以根据二维码或类似技术声明他们的设备。

一旦设备被声明，客户就成为其所有者，客户用户可以访问设备数据并控制设备。

设备声明场景

YiCONNECT 用户如果“知道”设备名称和密钥，就可以声明该设备。密钥是可选的，总是有一个过期时间，并且也可能随着时间的推移而改变。

可以通过两种不同的方式配置密钥：

  1. 设备端关键 场景 - 设备包含带有过期时间戳的过期时间服务器属性。仅当该客户能够使用设备声明小部件声明设备后，设备才会向 YiCONNECT 发送带有声明数据的声明请求。
  2. 服务器端关键 场景 - 设备包含具有声明数据的claimingData服务器属性和使用声明设备小部件的客户声明设备。

设备声明 API 请求

声明请求作为 POST 请求发送到以下 URL：

http(s)://host:port/api/customer/device/$DEVICE_NAME/claim

支持的数据格式为：

{
  "secretKey":"value"
}

注意： 消息中不包含durationMs参数，secretKey参数可选。

只要声明成功，设备就会被分配给特定客户。如果系统参数allowClaimingByDefault为 false ，则claimingAllowed属性将被自动删除。

此外，还可以回收设备，这意味着该设备将不再从客户手中分配。如果allowClaimingByDefault为false ， claimingAllowed属性将再次出现。

设备回收API请求

为了回收设备，您可以向以下 URL 发送 DELETE 请求（不要忘记将设备名称替换为正确的名称）：

curl -X DELETE https://yiqisoft.cloud/api/customer/device/$DEVICE_NAME/claim