# SN预注册协议

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：register_device

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

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "product_id",
    "类型": "number",
    "必填": "是",
    "说明": "小微硬件平台分配产品pid，接入时分配的"
  },
  {
    "参数名": "iot_device_list",
    "类型": "objarray",
    "必填": "是",
    "说明": "注册设备列表"
  }
]
```

">

### Body.iot_device_list(Array) `Object Payload`

注册设备列表

```json
[
  {
    "参数名": "sn",
    "类型": "string",
    "必填": "是",
    "说明": "设备标识，需在单个pid内保证唯一，代表一个具体的无力设备"
  },
  {
    "参数名": "device_auth_type",
    "类型": "string",
    "必填": "是",
    "说明": "设备签名认证方式，默认为 0"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "result",
    "类型": "number",
    "说明": "结果，0为成功，其他值为失败。"
  },
  {
    "参数名": "error_msg",
    "类型": "object",
    "说明": "错误信息，result为0时，返回之前已注册过的sn (对象字符串形式）"
  }
]
```

### Res.error_msg `Object Payload`

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

```json
[
  {
    "参数名": "existed_sn_list",
    "类型": "array",
    "说明": "在添加前，已备案过的设备"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

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

返回示例

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

## 6. 错误码

此接口没有特殊错误码，可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

## 7. 适用范围

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