# SN预注册协议

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:register_device

当你的硬件完成所有开发测试工作,并通过微信的官方审核。我们将在硬件平台中,完全开放对应的SN号的预注册服务。

通过硬件平台为你开发的设备(PID)绑定微信公众平台(服务号、小程序等)申请的app_id、app_secret,作为设备SN预注册的访问凭证。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/ilink/api/ilink_api_register_device?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填说明
product_idnumber小微硬件平台分配产品pid,接入时分配的
iot_device_listobjarray注册设备列表

# Body.iot_device_list(Array) Object Payload

注册设备列表

参数名类型必填说明
snstring设备标识,需在单个pid内保证唯一,代表一个具体的无力设备
device_auth_typestring设备签名认证方式,默认为 0

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
resultnumber结果,0为成功,其他值为失败。
error_msgobject错误信息,result为0时,返回之前已注册过的sn (对象字符串形式)

# Res.error_msg Object Payload

错误信息,result为0时,返回之前已注册过的sn (对象字符串形式)

参数名类型说明
existed_sn_listarray在添加前,已备案过的设备

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "product_id": 2,
    "iot_device_list": [
        {
            "sn": "abcpatric",
            "device_auth_type": 0
        },
        {
            "sn": "abcpatric1",
            "device_auth_type": 0
        }
    ]
}

返回示例

{
  "result":0,
  "error_msg":"{\"existed_sn_list\":[\"abcpatric\",\"abcpatric1\"]}"
}

# 6. 错误码

此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。