24、车场访客开放接口开发文档

发布日期：2024-05-09
更新日期：2024-05-09
接口说明：用于访客的新增和删除
## 一、接口协议

接口协议为http，https，Post请求，数据为Base64编码后的字符格式，数据写入请求body中。

返回数据为同步返回Base64位编码数据，  
示例：eyJzaWduIjoiNzQzM0M1NDZFOTEzOTkwNjJFNDhDRENBQ0VCOEE2MTUiLCJkYXR hIjp7Im1lc3NhZ2UiOiLnrb7lkI3plJnor68iLCJzdGF0ZSI6MH19  
****对返回数据进行Base64解码得到：****

{"sign":"7433C546E91399062E48CDCACEB8A615","data":{"message":"签名错误","state":0}}

****对sign值进行校验，一致则认为是合法数据。****

## 二、数据签名

厂商编号：union\_id  
厂商秘钥：不需要  
车场编号： comid  
车场秘钥： ckey  
云平台注册车场之后，每个车场有一个车场编号和一个车场秘钥，调用接口时必须传入身份comid和用数据签名。  
sign生成方法：对请求中的data数据加上key（ckey），进行MD5并转为大写。

示例：  
锁车接口：  
测试地址：[http://ts.bolink.club/zld/lockcar/dolock](http://test.bolink.club/zld/lockcar/dolock)

原始数据 {"data":{"comid":"kytest2020032501","union\_id":"200279","car\_number":"晋QQ1234","lock\_status":1}}

加上key后组成签名串 {"comid":"kytest2020032501","union\_id":"200279","car\_number":"晋QQ1234","lock\_status":1}key=MAVXUU3C2545G9K1

然后MD5加密后生成下面的sign  
sign:4973765089F20FCFE45868796F81278A

**再把sign和原始数据拼在一起如下  
{"data":{"comid":"kytest2020032501","union\_id":"200279","car\_number":"晋QQ1234","lock\_status":1},"sign":"4973765089F20FCFE45868796F81278A"}

对上面的数据 进行base64加密，得到以下数据，

并发送以下数据到测试地址http://yun.bolink.club/zld/visitor/sendVisitor

eyJkYXRhIjp7ImNvbWlkIjoia3l0ZXN0MjAyMDAzMjUwMSIsInVuaW9uX2lkIjoiMjAwMjc5IiwiY2FyX251bWJlciI6IuaZi1FRMTIzNCIsImxvY2tfc3RhdHVzIjoxfSwic2lnbiI6IjQ5NzM3NjUwODlGMjBGQ0ZFNDU4Njg3OTZGODEyNzhBIn0=  
返回结果  
eyJkYXRhIjp7InN0YXRlIjoxLCJtZXNzYWdlIjoi6ZSB5a6a5oiQ5YqfIeaCqOeahOi9pui+huW3sue7j+WkhOS6jumUgeWumueKtuaAgSzor7flnKjlh7rlnLrliY3op6PplIEs5ZCm5YiZ5peg5rOV5Ye65Zy6In0sInNpZ24iOiI0OTczNzY1MDg5RjIwRkNGRTQ1ODY4Nzk2RjgxMjc4QSJ9

解码：  
{"data":{"state":1,"visitor\_id":10240,"errmsg":"访客申请成功"},"sign":"4973765089F20FCFE45868796F81278A"}

## 三、接口列表

### 1. 访客登记管理接口

接口地址：http://yun.bolink.club/zld/visitor/sendVisitor

| 名称           | 说明                   | 类型     | 示例            | 是否必传字段 |
|--------------|----------------------|--------|---------------|--------|
| car_number   | 车牌                   | String | 渝NGCGCG       | 是      |
| begin_time   | 开始时间(unix时间戳格式，精确到秒) | Number | 1490875218    | 是      |
| end_time     | 结束时间(unix时间戳格式，精确到秒  | Number | 1490875218    | 是      |
| remark       | 备注                   | String | sdasdafa      | 否      |
| operate_type | 操作类型                 | number | 1添加3删除        | 是      |
| mobile       | 电话                   | String | 15000000000   | 否      |
| park_id      | 泊链编号                 | String | 24            | 是      |
| union_id     | 厂商编号                 | String | 10774         | 是      |
| is_approval  | 是否自动审核               | Number | 0 需要审核 1 自动审核 | 是      |
|              |                      |        |               |        |

示例：

{"data":{"car\_number":"鄂A11111","begin\_time":"1714010815","end\_time":"1714097215","remark":"11111","operate\_type":1,"mobile":"12345678","bolink\_id":36342,"union\_id":200712,"is\_approval":1},"sign":"590C2B1C8B99B415623E03C7797C9BEB"}

Base64加密：eyJkYXRhIjp7ImNhcl9udW1iZXIiOiLphIJBMTExMTEiLCJiZWdpbl90aW1lIjoiMTcxNDAxMDgxNSIsImVuZF90aW1lIjoiMTcxNDA5NzIxNSIsInJlbWFyayI6IjExMTExIiwib3BlcmF0ZV90eXBlIjoxLCJtb2JpbGUiOiIxMjM0NTY3OCIsImJvbGlua19pZCI6MzYzNDIsInVuaW9uX2lkIjoyMDA3MTIsImlzX2FwcHJvdmFsIjoxfSwic2lnbiI6IjU5MEMyQjFDOEI5OUI0MTU2MjNFMDNDNzc5N0M5QkVCIn0=

**方法返回：**

| 名称      | 说明 | 类型     | 示例     | 是否必传字段 |
|---------|----|--------|--------|--------|
| state   | 状态 | Number | 0失败1成功 | 是      |
| message |    | String |        | 是      |
| sign    |    | String |        | 是      |

返回的base64：eyJkYXRhIjp7InN0YXRlIjowLCJtZXNzYWdlIjoi6Ieq5Yqo5a6h5qC46YCa6L+HIn0sInNpZ24iOiI1OTBDMkIxQzhCOTlCNDE1NjIzRTAzQzc3OTdDOUJFQiJ9

示例：  
{"data":{"state":0,"message":"自动审核通过"},"sign":"590C2B1C8B99B415623E03C7797C9BEB"}