使用说明

一、项目背景

二、通讯机制

接口通讯：
采用HTTP协议，默认POST方式方式，Json数据格式。

三、接入步骤

管理员登录当前需要对接的拼控器web系统，获取接入方pId和secretKey（设置-Open API管理, 添加一条对接信息,如下图所示）

pId：接入方Id
secretKey: 接入方密钥（可修改）
2. 根据接入方业务需求和接口文档开发。
3. 开启加密之后需要将请求参数按照加密方式传输过来，非加密直接传递就可以，可参考一下例子
加密

非加密

四、数据格式

接口消息分为请求头和请求体两部分，下方描述为请求体; 请求体必须为以下四部分:
body: 只放入接口请求参数
sign: 消息签名
pId: 对接的项目id
timeStamp: 当前时间，精确到毫秒

加密:
Body 为密文传输,如下所示:
请求参数：

{
    "body": "yqJeC3BgcOHfKReCHzmhtp8VH1Fr3vxi",
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}

非加密:
Body 为明文传输,如下所示:
请求参数：

{
    "body": {
        "deviceId": 0
    },
    "sign": "YjlhMWRmZTVlNzJhYTg4MTgzMDFhNTdlOWE0NjMyNDc=",
    "pId": "YmRj",
    "timeStamp": "1689586062335"
}

timeStamp:当前时间，精确到毫秒。
sign:消息签名。签名规则为
启用加密：Base64(md5（body密文+timestamp+pId+secretKey))
禁用加密：Base64(md5（timestamp+pId))
body为业务数数据
启用加密，加密规则为：Base64(DES（body明文）)
禁用加密：body明文
注意: (md5要按照16进制处理)

1.输出消息：
设备响格式/基础报文

{
"status": 0,
 "msg": “”,
"sign": "", 消息签名
"body": ""
}

status：0表示成功，其他为失败
msg：错误消息
sign: 消息签名规则同传入数据
body: 业务数据，规则同传入数据
注意: 当报非接口错误时, 响应报文仅为以下:

{
"status": 系统错误码,
"msg": “”,
"body": ""
}

下文涉及的输入输出地方只描述body明文部分。
2.签名和加密举例(以python为例)：
Des 加密：

Des 解密

五、接口地址

接口地址根目录${root}为URL的固定部分，

如：http://192.168.10.228:8000/open/api

下面每项接口URL描述将省略${root}部分，只描述后续内容。

注意:以下示例按照不加密方式进行调用; 凡是未标明是可选参数的那该示例中的请求参数均为必填项

一、项目背景#

二、通讯机制#

三、接入步骤#

四、数据格式#

五、接口地址#

一、项目背景

二、通讯机制

三、接入步骤

四、数据格式

五、接口地址