1.1 文档说明
本文档系统化描述视觉地磁项目收费系统接入的API参考样例信息。
接入说明
调用双方需要进行调用地址授权,请在调用前提供调用方的IP地址,授权后才允许调用。
接入步骤
1.组装要发送给接口的数据对象(不同接口参考下面章节的接口调用请求定义)。
2.把所有要发送给的数据组成JSON格式,以HTTP方式送给此平台统一接口调用地址。
鉴权规范
系统支持以下鉴权规范。
平台调用提供方参数说明
sign为必传字段,用于鉴权验证。
MD5鉴权规范
双方共同约定密钥secret,使用secret对请求参数按一定规则签名生成sign,带入链接中,根据规范生成sign字段,传给提供方,提供方按照事先提供的密钥secret对入参进行加密生成sign字段进行验证,内容一致代表请求合法有效。
对于加密的参数对象,根据提供的注册接口入参为准。
该鉴权方式可确保数据在传输过程中不被恶意篡改,保障数据的完整性以及能力的安全性。签名验证的鉴权规则如下:
1.对于请求参数以key value 形式拼接在url上的
对请求的入参按字母升序排序并用&符号拼接,然后将秘钥和&&符号拼接到入参前,然后进行MD5运算即
md5(secret&&key1=value1&key2=value2),生成大写加密数据。
注意key1和key2按字母顺序排序(不区分大小写)
例如:请求参数为account=dict_test1, password=Z2V5ZUAyMDE4IQ==,秘钥为m8X2uT88
则最后拼接为
md5(m8X2uT88&&account=dict_test1&password=Z2V5ZUAyMDE4IQ==) 即得出sign=CAB7CB256CC1770E910EFD2BB5E907A4
实际调用示例,提供方收到的请求数据如下:http://192.168.1.100:8080 /list?sign=895294A6188BA5FCC20C5873CB82E4B3
2.对于请求参数是json格式的
对请求包体中的字段按字母升序排序,然后将秘钥和&&符号拼接到入参前,然后进行MD5运算即
md5(secret&&{”key1”:”value1”,”key2”:”value2”….}),生成大写加密数据。
注意key1和key2按字母顺序排序(不区分大小写)
例如:请求包体为
"param":{
"areacode":"111",
"devicetype":"132",
"industrytype":"00",
"memberkey":"111",
"networkid":"1",
"qty":3
}
秘钥为:5n01793f
则最后拼接为
md5(5n01793f&&{"areacode":"111","devicetype":"132","industrytype":"00","memberkey":"111","networkid":"1","qty":3})
即得出sign= F2FF00E149951F286D580FDC2AB50DE4
实际调用示例,提供方收到的请求数据如下:
{
"sign":"A458C6049CA59E710E283F564EC00404",
"param":
{
"tenantKey":"E8g82TUk",
"status":1
}
}
1.1.1.1 前端主机状态接口
接口功能
获取前端主机状态。
调用方法: POST
接口路径 http://*/api/device/list
注意事项
http携带头域信息:
Header:Content-Type:application/x-www-form-urlencoded;
参数说明
返回结果
消息事例
返回码
1.1.1.2 车辆进场接口
接口功能
当有车辆进入时,平台将车辆进场信息推送给接入方(由接入方提供)。
调用方法: POST
接口路径: http://*/api/parking/join
注意事项
http携带头域信息:
Header:Content-Type:application/x-www-form-urlencoded;
参数说明
返回结果
消息事例
返回码
1.1.1.3 车辆进场接口
接口功能
当有车辆进入且停稳后,平台将车辆停稳信息推送给接入方(由接入方提供)。
调用方法: POST
接口路径: http://*/api/parking/stop
注意事项
http携带头域信息:
Header:Content-Type:application/x-www-form-urlencoded;
参数说明
返回结果
则最后拼接为
返回码
1.1.1.4 车辆离场接口
接口功能
当车辆离场时,平台将离场信息推送给接入方。(由接入方提供)
调用方法: POST
接口路径: http://*/api/parking/out
http携带头域信息::
Header:Content-Type:application/x-www-form-urlencoded;
参数说明
返回结果
消息事例
返回码
1.1.1.5 停车报警接口接口功能
接口功能
当车辆离场时,平台将离场信息推送给接入方。(由接入方提供)
调用方法: POST
接口路径: http://*/api/parking/alert
http携带头域信息::
Header:Content-Type:application/x-www-form-urlencoded;
参数说明
返回结果
消息事例
返回码
1.1.1.6 前端主机心跳接口
接口功能
当车辆离场时,平台将离场信息推送给接入方。(由接入方提供)
调用方法: POST
接口路径: http://*/api/parking/alert
http携带头域信息:
Header:Content-Type:application/x-www-form-urlencoded;
参数说明
返回结果
消息事例
返回码