河北省自助发放机对接规范

一． 公共参数与签名

1.1. 接口服务域名

APP_HOST：接口服务域名，由平台管理员提供。

1.2. 传入公共参数

为保证数据安全，在所有的接口调用中都加入了以下公用参数，部分参数由平台提供。

签名是指使用某种算法（如MD5，与平台管理员协商后保持一致即可）对appId + secretKey+timestamp 组成的字符串加密，得到该记录对 应的签名，下面以MD5算法为例：

sign=md5(appId+ secretKey+timestamp)

其中 appId 和secretKey均由平台提供给接口调用方，timestamp 为时间戳。

1.3.输出公共参数

对于返回值有三个公共返回参数retCode、message及token，retCode代码接口调用是否成功，00-代表成功，1X-代码失败，在失败时，message包含具体的错误说明。

1.4.首次调用获取token

在第一次调用接口前，要获取一次token，以后不必再调用此接口，以后每次调用接口都会返回token。

1. 接口地址

（2）接口参数

（3）返回结果

二． 群众注册信息同步接口

2.1. 接口说明

本接口用于向平台推送群众注册信息；群众注册时与初始同步信息时调用。

2.2. 接口参数

2.3. 请求格式

请求参数说明：

请求参数示例：

{

"appId":"20183xxxxx"，

"secretKey":"1298083681xxx"，

"timestamp":"1446190200002"，

"sign":"AKDLDHISDFLDSFKJlxxx"，

"token":"16635890992"，

"jsonString":"[{deviceId:370001001,name:张三,sex:01,telephone:15226783795,

districtId:370000000000}]"

}

2.4. 返回格式

返回结果说明：

返回结果示例：

{

"retCode": 00,

"message": "同步成功！"，

"token": "16635890992"

}

三． 群众领取记录同步接口

3.1. 接口说明

本接口用于向平台推送群众领取药具记录信息；群众领取时与初始同步信息时调用。

3.2. 接口参数

请求参数说明：

请求参数示例：

{

"appId":"20183xxxxx"，

"secretKey":"1298083681xxx"，

"timestamp":"1446190200002"，

"sign":"AKDLDHISDFLDSFKJlxxx"，

"token":"16635890992"，

"jsonString":"[{deviceId:370000001,telephone:15226788888,productCode:DLS,batchNo:20180917001,count:10}]"

}

3.3. 返回格式

返回结果说明：

返回结果示例：

{

"retCode": 00,

"message": "同步成功！"，

"token": "16635890992"

}

四． 发放机配货同步接口

4.1. 接口说明

本接口用于发放机配货时向平台推送数据。

4.2. 接口参数

请求参数说明：

请求参数示例：

{

"appId":"20183xxxxx"，

"secretKey":"1298083681xxx"，

"timestamp":"1446190200002"，

"sign":"AKDLDHISDFLDSFKJlxxx"，

"token":"16635890992"，

"deviceId":"371000001",

"items":"dls|18032401|20|361"

}

4.3. 返回格式

返回结果说明：

返回结果示例：

{

"retCode": 00,

"message": "上货成功！"，

"token": "16635890992"

}

五． 发放机信息同步接口

5.1. 接口说明

本接口用于厂商向平台推送自助发放机的基础信息;发放机信息变更与初始同步信息时调用。

5.2. 接口参数

请求参数说明：

请求参数示例：

{

"appId":"20183xxxxx"，

"secretKey":"1298083681xxx"，

"timestamp":"1446190200002"，

"sign":"AKDLDHISDFLDSFKJlxxx"，

"token":"16635890992"，

"jsonString":"[{pointId:370000001,pointName:保定市人工发放点,nickName:保定市药具站自助发放机,

districtId:370000000000,address:保定市药具站,longitude:115.01212,latitude:38.23231,capacity:52

,count:发放机剩余量,maintainer:ff80808166b67b030166bdd6204f0396,maintainerName:张三,maintainerPhone:15226788888,state:00}]"

}

5.3. 返回格式

返回结果说明：

返回结果示例：

{

"retCode": 00,

"message": "同步成功！"，

"token": "16635890992"

"devices":["nickName":"xxx市药具站自助发放机","deviceId":"371000001"]

}

六． 注意事项

本文档接口内容有可能因为系统平台的升级等原因在实际联调时有微小变化，以实际联调时的接口文档为准。