添加设备

将设备添加到星纵物联开放平台，并与应用关联一起。

请求URL 

POST {base_url}/device/openapi/v1.0/devices

请求参数

表 1. 头部参数
参数 是否必填 类型 描述
Authorization 是 String API调用的有效访问token。

格式为 Bearer {access_token}。
表 2. 主体参数
参数 是否必填 类型 描述
snDevEUI 是 String 设备的SN（序列号）或EUI（扩展唯一标识符）。
name 是 String 对设备进行命名以帮助您识别此设备。
description 否 String 输入设备说明
autoProvision 否 Boolean 是否启用此设备的自动配置，该配置将在设备添加完成后，自动将预配置的设置从配置文件模板应用到此设备。
注： 自动配置目前支持以下的设备： SG50, UG63, VS121-P和 VS133-P。
有效值:
  • false: 有效值禁用
  • true: 有效值启用
    注： 当值设置为true时，您需要在profile参数中选择包含特定设备的配置文件。
profile 否 String
注： 当autoProvision设置为true. 时，此参数是必需的。

自动配置的配置文件模板，以 JSON格式呈现。

您可以使用默认的配置文件模板或创建一个自定义模板，有关更多信息，请参阅以下主题：
project 否 String 设定一个标签以帮助你更好的识别和分类设备。

响应参数

参数 类型 描述
data Object<Device_Info> 添加设备的信息
status String API的请求结果。
  • Success
  • Failed
requestId String 唯一的请求ID ,可用于快速定位请求。
设备信息
参数 类型 描述
String 设备的SN（序列号）。
deviceId Integer 在星纵物联开放平台上设备唯一的ID。
注： 建议保存此设备ID以备未来使用，因为它通过API管理或配置设备时是必需的要填入的。
devEUI String
注： 根据产品型号的不同，此参数可能不会被返回。
EUI（设备的唯一标识符）。
imei String
注： 根据产品型号的不同，此参数可能不会被返回。
设备IMEI（国际移动设备识别码）号

示例

请求示例
将VS121-P添加到星纵物联开放平台应用中。
POST /device/openapi/V1.0/devices HTTP/1.1
Host: milesight.demo.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzY5NTQ4MDE3MTMzMjgxMzAifSwiZXhwIjoxNzAzMjEzMDk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiYjJjN2U4Yy03NGQwLTQ4NjEtODE3MS1iYTc0NWRlMGY0NmQiLCJjbGllbnRfaWQiOiI4OTNkNzdjNy1mMGNiLTRmMzQtOWNhMS03YzJhNGNmMTEzNDgiLCJ0cyI6MTcwMzIwOTQ5ODMzNH0
Content-Type: application/json
User-Agent: OpenAPI

{
    "snDevEUI": "66003649xxxx",
    "name": "Sample VS121-P",
    "description": "VS121-P on meeting room 3D",
    "project": "Workplace-management"
}
响应示例
HTTP/1.1 200 OK
{
    "data": {
        "sn": "66003649xxxx",
        "deviceId": "1737007595605147649"
    },
    "status": "Success",
    "requestId": "22bd34b548bca2981b4bb5f222523caf"
}