接口版本记录

版本号 支持功能
v1 使用Productid、SN进行设备注册，换取设备证书信息以及“产品管理平台”配置的设备烧录信息。根据生产计划或内容自定义设备标签。
v2 使用Productid、SN进行设备注册，换取设备证书信息以及“AIoT开发者平台”配置的设备烧录信息。根据生产计划或内容自定义设备标签。支持在”产品管理平台“设置产品下设备的设备分发策略。

接口逻辑图

接口文档

简要描述

  • 设备烧录信息接口

接口版本

版本号 制定人 制定日期 修订日期
2.0 张浩 2023-3-1

请求URL

  • /sweeper-register-server/v2/register

请求方式

  • POST

请求头

参数名 是否必须 类型 说明
Content-Type 是 string 请求类型： application/json

请求参数

{ 
 "productId": "ZxaUAwkOee",
 "label": {
    "country":"cn"
 },
 "sn": "YS2ACT229KCB01C01313"
}

请求参数说明

参数名 是否必须 类型 说明
productId 是 string 产品ID
label 是 Object 标签Map, key 为标签key ，value 为标签值 , 必传标签：key 为 ‘country’ ，值为国家码，必须要在产品管理平台配置对应产品及对应国家
sn 是 string SN号

返回示例

正确时返回:

{
    "code": 0,
    "msg": "ok",
    "err_code": 10000,
    "data": {
        "productId": "ZxaUAwkOee",
        "deviceId": "da1629127a074d01915e8c09445a72fc",
        "auth": {
            "secret": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCiuBgYHmcFnVTG\n+L5islCNDXDhLbBcN1h1YhJJSFsv0OEAh4Xqt56GjAsVC8vuBY7nAFMCRcrqAt+T\nv70pY1t0nernW9r/5icVFllD3mdlt+TdoykK1cjfVgIyQDep6UlYwz1wOHSWH+0x\nNN1bKIaV3ccIpp7OLvDF03u6Da64yiJJOGZAMnk4gsCOAHKo9TMMMgIMAGGDldtu\ns/H//lCTKCTP0J4mB89uCImTTZzricUWJA9NI7ZlI32kWUO9EavsSrD3tEPPCwp6\neEUjJTlwb6rMxiiQYN+pRedOaUc36inPORgfiqI1OFyGT2yQwCxxzMcbUQhphtFz\nEz9IImXzAgMBAAECggEANAeQcLnb8EAn+P1VhyKEPi3zj5T35OyvhM0okrUnryjn\noS80Y2J2Noh2DLM6cG/nizaf1ESzxtLHYat4FVFXT3klQPgulQ+nJIeCYICvaCd+\nb146A+Rq9/q89gtxoQtesBqxvP3YTZ6Ezeyc8QaKzkXdXAdHFR+OTns6fznbyesZ\nuCMrKFop0XWLDjOVOLPnECJO7pwcNNmE5xRphGOMcdPrxS3uK1yikjsDVIACQjOc\nz6dX55sMJkwvL8vxil5b9C3c3Fhbzcvl8SU5myFyy76sxwc5zuDj2O5xzhcLYAs6\nrbS0UhfM5sOEhdEBu4H9I3qPLJTgadnrY8q2RtGDoQKBgQDNHhXlDyVY8LLBTvxs\n3ToRSJLWBI1qdLAgxuqPHxRmHTeFBlecoyhbg/8Kn5NS1RoZEco7OW6PMsQZb5ZW\nmqsqVFVps0Ku9f/L/yO/EYLHoUIsqQGNiX9c6VqwG5ZCTo5CnBvG2Cvjsvj/th/r\n7OfDWG2Ms/opupDWZ9KOsZfQ0wKBgQDLFYNgdrYO2KUw1FKJxAVcgx713/1d0p58\nf1J9QyHq7rsaY6J2x1Rjfa7bGZUCDSEBJ9sZ7LatUnX/fQ/4hbbtwC03dPPB1ruJ\nFiiHjhBLhVYU0emGghrdInbzGRYU0oHLqi7HzF4/3fgNWQn8RopI/SGmUkDWc/Om\nhcBDsnbiYQKBgQCb6S1tUijqRPMq+rXmrfXQY2Cxav5vF8k08N4j8dTYlYa5B4wa\n1O39OgTnd0pNYQwYWCxm/g2qrUTfrLESnThT0Yym7opWYUiRMBtkxZOp2Eprlf9H\nLWdxITM8v4tkVT/PI8f9Sh16U3TvMelrtESqeJG0rK0PgO9M+dfTfOxP3wKBgH7v\nVG1/5a2D5kSOAYUQm5VGc5yVQ2VYVy1T27hltJaGXzZQXmTFlE6XaSqTY9qjYCS7\nx6v9k/TjnNNzVP8ufLdALkMCe7WFxTQbQHvx5Od/UN20krU7LxVXDGhIHtAm/2/Q\nUGsbpzFeSUP2ilI/uQGEDntJ4DLqyLkl0pW9v6chAoGASvASbBe3y3mDCvt3GoRQ\nu/sTQ1ft/mAgOd/l0DVAq5PwpTJOOPIMV/ta2SO0bBByLsb7ur+3aI3V71ninImg\no8FDOmwjCJVCrdvY4U4CdMarisab4n9oGUVW8eB073LecY8uZ/iuYZDjhnIdi6I5\n9FKDfnlS+6UdV8aXOftXmQM=\n-----END PRIVATE KEY-----\n"
        },
        "extend": {
            "activateCode": "9588",
            "country": "it",
            "sn": "YS2ACT229KCB01C01313",
            "otaVerify": {
                "secret": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1+MhDY6RA4lmWO/hbcvM\n5g/Y5p2azFuxH3Ew+/8lf+0XqMT56qPpZZRvgMyjNUuB9nk2utR5Uy+RuRiTKgPN\ncD28dQAiE1VGmeJh13ByGqaRpm0YxOg3915wFpsntNW3MwrgkEIrR5LjhLm9Hk6g\nUtOseZa+EoxmZm++/5rCTI0+HMhuFQG4XyuPXW0Ij0J0AKqD0hZEdn5hxZ7Dj012\nxYuWy+QfUO4YgvKA4gDxnGStWaEM4EL7EPi2NtRWjoJBCKj7z+8JOjFvhL4cKIZD\njkqnnVj+BEsBU09cHhoUDHc5GiXypjav/ZwhHguI4S/Jso3enASzFYblewTrRtcq\nmwIDAQAB\n-----END PUBLIC KEY-----\n"
            },
            "countryConfig": {
                "cn": {
                    "activeUrl": "https://testcn-sweeper.narwaltech.com/universal/p2/active.html?a=1Fe29B09473F9469c972BFc1503413525cd95A95a398fbc66",
                    "apDistributionNetworkUrl": "https://testcn-sweeper.narwaltech.com/universal/p2/dsdk.html?b=0&a=1Fe29B09473F9469c972BFc1503413525cd95A95a398fbc66",
                    "bindUserUrl": "https://testcn-sweeper.narwaltech.com/universal/p2/dsdk.html?b=1&a=1Fe29B09473F9469c972BFc1503413525cd95A95a398fbc66",
                    "openApiUrl": "https://testcn-open.narwaltech.com",
                    "mqttUrl": "mqtts://testcn-mqtt.narwaltech.com",
                    "sweeperUrl": "https://testcn-sweeper.narwaltech.com",
                    "dataReportUrl": "https://testcn-open-data.narwaltech.com/report"
                }
            },
            "optionalConfiguration": {
                "ApNetworkUrl": "https://testcn-sweeper.narwaltech.com/universal/p2/dsdk.html?b=0&a=",
                "ItActiveUrl": "https://testcn-sweeper.narwaltech.com/universal/p2/active.html?a="
            },
            "domain": {
                "deviceBootstrapUrl": "testcn://testiot-auth-global.narwaltech.com/device-bootstrap-server/v1/bootstrap"
            }
        }
    }
}

错误时返回:

{
    "code": -1,
    "msg": "设备国家码不能为空",
    "err_code": -1
}

返回字段说明

字段名称 字段类型 是否必须 描述
1 code int 是 状态码，为0时表示接口调用成功，不为0时表示接口调用失败
2 err_code int 是 错误码，当code为0时，返回10000，否则返回对应错误码
3 msg String 是 错误的具体消息
4 data Object 是 返回具体数据

data 字段说明：

字段名称 字段类型 是否必须 描述
1 extend Object 是 设备扩展信息
2 productId String 是 产品ID
3 deviceId String 是 设备ID
4 auth String 是 设备认证信息

extend 字段说明：

字段名称 字段类型 是否必须 描述
1 country String 是 设备国家码
2 activateCode String 是 激活码
3 otaVerify Object 否 设备OTA加密信息，如该产品不需要OTA签名加密，则为空
4 optionalConfiguration Object 是 Map 类型，烧录配置信息。在AIoT开发者平台配置，详见站点与烧录配置 。
5 domain Object 是 Map 类型，域名配置信息。除deviceBootstrapUrl字段外,其余字段在AIoT开发者平台配置，详见站点与烧录配置 。
6 sn String 是 SN号
7 countryConfig Object 是 Map 类型，key 为 国家码 ，value 为下面属性 对象。为原来在产品管理平台配置的烧录信息。

若设备接入了设备分发功能，则不需要在产品管理平台配置该信息，仅在AIoT开发者平台配置即可，配置方法详见站点与烧录配置。

otaVerify 字段说明：

字段名称 字段类型 是否必须 描述
1 secret String 是 OTA加密签名秘钥，算法为RSA，类型为公钥

domain 字段说明：

字段名称 字段类型 是否必须 描述
1 deviceBootstrapUrl String 是 设备分发域名地址，详见：设备分发
2 activeUrl String 否 激活二维码地址，需配置才有
3 apDistributionNetworkUrl String 否 AP配网码地址，需配置才有
4 bindUserUrl String 否 绑定用户码地址，需配置才有

countryConfig 字段说明：

字段名称 字段类型 是否必须 描述
1 dataReportUrl String 否 数据埋点上报地址
2 activeUrl String 否 激活二维码地址
3 apDistributionNetworkUrl String 否 AP配网码地址
4 bindUserUrl String 否 绑定用户码地址
5 mqttUrl String 否 长链接服务地址
6 sweeperUrl String 否 扫地机器人服务地址
7 openApiUrl String 否 开放平台服务地址

auth 字段说明：

字段名称 字段类型 是否必须 描述
1 secret String 是 设备秘钥，根据产品认证类型返回不同的秘钥

备注

  • 更多返回错误代码请看首页的错误代码描述
 创建时间：2024-07-15 21:18
最后编辑：陈勇琦  更新时间：2024-10-18 10:58