全部产品

停车开放服务调用前置对接

更新时间:2020-05-27 15:16:17

一、开放平台对接前置条件说明

1.1、开放平台服务对接前置条件简介

对接或调用阿里云全域停车开放服务时需要有一些前置条件,例如:调用场库信息上架高德的服务时,停车企业需要将场库的信息接入阿里云全域停车开放平台;又比如企业需要调用车牌二次识别服务时,企业需要将停车场车辆进出的图片上传至阿里云全域停车开放平台。

1.2、开放平台服务对接前置条件架构

合作伙伴的停车场库系统通过接口等形式对接到阿里云智能停车平台对接,可以充分利用阿里的生态、数据能力,构建出更具竞争力的应用。和智能停车平台一次接入,就能参数扩展的方式快速接入多种上层停车场景能力。
image.png
说明:接口调用所需的平台授权参数,请向平台管理员 @云叶 咨询获取
关于API的调用方法,需要使用平台提供的SDK调用,SDK和Demo调用示例,有多种不同的语言版本,JAVA、.Net、PHP、Python、Node.js。文档中所提到的所有API,调用方式均一样,不同API的只是Path,和Post请求payload的不同,API调用时请求的payload格式请参考后续章节各个API的请求格式说明。
(1)JAVA: 按Java SDK示例调用
(2)PHP: 示例Demo https://github.com/aliyun/api-gateway-demo-sign-php.git
(3)C#: 示例Demo https://github.com/aliyun/api-gateway-demo-sign-net
(4)Python: 示例Demo https://github.com/aliyun/api-gateway-demo-sign-python
(5)Node.js: 示例Demo https://github.com/aliyun/api-gateway-nodejs-sdk

1.2.1 API调用示例

1.2.1.1 JAVA SDK

POM依赖:

  1. <!-- https://mvnrepository.com/artifact/com.aliyun.iotx/iotx-api-gateway-client -->
  2. <dependency>
  3. <groupId>com.aliyun.iotx</groupId>
  4. <artifactId>iotx-api-gateway-client</artifactId>
  5. <version>1.0.3</version>
  6. </dependency>

示例代码:

  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("${appKey}");
  3. ioTApiClientBuilderParams.setAppSecret("${appSecret}");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("${apiVersion}");
  8. // 接口参数
  9. request.putParam("param1", "${paramValue}");
  10. //请求参数域名、path、request
  11. ApiResponse response = syncApiClient.postBody("${apiHost}",
  12. "${apiPath}", request);
  13. System.out.println("response code = " + response.getCode()
  14. + " response content = " + new String(response.getBody(), "utf-8"));


其他语言调用示例参见1.2示例Demo。

1.2.2 开放接口

1.2.2.1 系统保障接口

1.2.2.1.1 心跳上传(必选)

概述
停车场库系统向智能停车平台发送心跳,用于监控停车场是否在线。对于本地场库系统(由本地管理直接对接到阿里云智能停车平台),为保证可用性,每个停车场须定期向平台发送心跳,推荐的周期为1分钟。云端对接方式,可根据情况判断是否接入。
接口
path: /park/isv/v1/park/heartbeat/upload
version: 1.0.0
参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 场库系统的停车场ID
uploadTime Long UTC时间(UNIX毫秒时间戳)
业务响应参数:
参数名称 参数类型 必填 长度 说明
serverTime String 停车场id

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId","2947297626687");
  10. request.putParam("uploadTime", 1550030400000);
  11. //请求参数域名、path、request
  12. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  13. "/park/isv/v1/park/heartbeat/upload", request);
  14. System.out.println("response code = " + response.getCode()
  15. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId":"2947297626687",
  5. "uploadTime":1550030400000
  6. },
  7. "request":{
  8. "apiVer":"1.0.0"
  9. },
  10. "version":"1.0"
  11. }

响应示例

  1. {
  2. "code": 200,
  3. "data": {
  4. "serverTime": 1550030410000
  5. },
  6. "message": "success"
  7. }

1.2.2.2 停车数据接入

1.2.2.2.1 车场余位更新(必选)

概述

当车辆进出场后余位发生变化时,停车场库系统将车场实时将可用余位同步到智能停车平台。如无法做到实时上报,需要定期更新,推荐的周期为1分钟。

接口

path: /park/isv/v1/park/availablespace/update
version: 1.0.0

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 场库系统的停车场ID
uploadTime Long UTC时间(UNIX毫秒时间戳),不传时取服务器时间
availableSpace Integer 车场总余位数量
availableOpenSpace Integer 车场对外开放车位余位数
业务响应参数:
参数名称 参数类型 必填 长度 说明
- 无业务返回参数

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId","2947297626687");
  10. request.putParam("uploadTime", 1550030400000);
  11. request.putParam("availableSpace", 99);
  12. request.putParam("availableOpenSpace", 88);
  13. //请求参数域名、path、request
  14. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  15. "/park/isv/v1/park/availablespace/update", request);
  16. System.out.println("response code = " + response.getCode()
  17. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "2947297626687",
  5. "uploadTime": 1550030400000,
  6. "availableSpaces": 99,
  7. "availableOpenSpaces": 88
  8. },
  9. "request":{
  10. "apiVer":"1.0.0"
  11. },
  12. "version":"1.0"
  13. }

响应示例

  1. {
  2. "code": 200,
  3. "data": {},
  4. "message": "success"
  5. }

1.2.2.2.2 车场入场记录上传(必选)

概述

车辆入场完成成,实时将停车记录上传到云端。除了同步记录,可以调用智能停车平台的云端能力进行更多业务处理,例如”先离场后付费”停车场景能力中签约状态的查询,具体能力场景请参见停车场景能力文档。停车场库系统可以根据的业务需求选择性接入相应的停车场景能力。

接口

path: /park/isv/v1/park/record/enter
version: 1.0.0

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 场库系统的停车场ID
vendorRecordId String 64 场库系统的停车记录ID
plateNo String 16 车牌号
plateColor String 车牌颜色,枚举值如下:
- BLUE : 蓝色
- YELLOW : 黄色
- GREEN : 绿色
- BLACK : 黑色
- WHITE : 白色
inTime Long 入场时间,UTC时间(UNIX毫秒时间戳)
inPictureUrl String 512 车辆入场图片,实时性要求高时可以通4.2.7图片上传接口补传图片
inChannelId String 64 入口通道(出入口/岗亭)ID,没有对通道进行管理的停车系统传”无”
inChannelName String 64 入口通道(出入口/岗亭)名称,没有对通道进行管理的停车系统传”无”
bizParams String 车场景能力业务参数,JSON字符串格式,相关说明参见车场景能力文档
业务响应参数:
参数名称 参数类型 必填 长度 说明
bizResults String 车场景能力业务结果,JSON字符串格式,相关说明参见车场景能力文档
业务异常:
异常码 说明
2002 厂商停车场ID不存在
3002 停车记录ID重复

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId","2947297626687");
  10. request.putParam("vendorRecordId","R20200218135602565");
  11. request.putParam("plateNo", "苏B11111");
  12. request.putParam("plateColor", "BLUE");
  13. request.putParam("inTime", 1550030400000);
  14. request.put("inPictureUrl", "http://aliyun.com/parking.jpg");
  15. request.put("inChannelId", "C19008934");
  16. request.put("inChannelName", "天鹅座东门入口");
  17. # 停车场景能力业务参数,根据需要传参
  18. Map<String, JSONObject> bizParams = new HashMap<>();
  19. JSONObject bizParam1 = new JSONObject();
  20. bizParam1.put("alipayUserId", "2800437569838574893759327547");
  21. bizParams.put("LEAVEPAY", bizParam1);
  22. request.putParam("bizParams", JSON.toJSONString(bizParams));
  23. //请求参数域名、path、request
  24. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  25. "/park/isv/v1/park/record/enter", request);
  26. System.out.println("response code = " + response.getCode()
  27. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "2947297626687",
  5. "vendorRecordId": "R20200218135602565",
  6. "plateNo": "苏B11111",
  7. "plateColor": "BLUE",
  8. "inTime": 1550030400000,
  9. "inPictureUrl": "http://aliyun.com/parking.jpg",
  10. "inChannelId": "C19008934",
  11. "inChannelName": "天鹅座东门入口",
  12. "bizParams": "{
  13. \"LEAVEPAY\": {
  14. \"alipayUserId\": \"2800437569838574893759327547\"
  15. }
  16. }"
  17. },
  18. "request":{
  19. "apiVer":"1.0.0"
  20. },
  21. "version":"1.0"
  22. }

响应示例

  1. {
  2. "code": 200,
  3. "data": {
  4. "bizResults": "{
  5. \"LEAVEPAY\": {
  6. \"bizState\": 200,
  7. \"bizContent\": {
  8. \"alipayUserId\": \"2800437569838574893759327547\",
  9. \"alipayParkingId\": \"PI1571995775528118818\",
  10. \"authLevel\": 2
  11. }
  12. }
  13. }"
  14. },
  15. "message": "success"
  16. }

1.2.2.2.3 车场离场记录上传(必选)

概述

车辆离场完成成,实时将停车记录上传到云端。除了同步记录,还可以调用智能停车平台的云端能力进行更多业务处理,例如”先离场后付费”停车场景能力中的催缴通知,具体能力场景请参见停车场景能力文档。停车场库系统可以根据的业务需求选择性接入相应的停车场景能力。

接口

path: /park/isv/v1/park/record/depart
version: 1.0.0

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 场库系统的停车场ID
vendorRecordId String 64 场库系统的停车记录ID,和入场记录ID一致
plateNo String 16 车牌号
plateColor String 车牌颜色,枚举值如下:
- BLUE : 蓝色
- YELLOW : 黄色
- GREEN : 绿色
- BLACK : 黑色
- WHITE : 白色
inTime Long 入场时间,UTC时间(UNIX毫秒时间戳),传入该参数时会更新停车记录中的入场时间
outTime Long 离场时间,UTC时间(UNIX毫秒时间戳)
outPictureUrl String 512 车辆离场图片,实时性要求高时可以通4.2.7图片上传接口补传图片
outChannelId String 出口通道(出入口/岗亭)ID,没有对通道进行管理的停车系统传”无”
outChannelName String 出口通道(出入口/岗亭)名称,没有对通道进行管理的停车系统传”无”
bizParams String 车场景能力业务参数,JSON字符串格式,相关说明参见车场景能力文档
业务响应参数:
参数名称 参数类型 必填 长度 说明
bizResults String 车场景能力业务结果,JSON字符串格式,相关说明参见车场景能力文档
业务异常:
异常码 说明
2002 厂商停车场ID不存在
3001 车辆离场对应的入场记录不存在
3002 停车记录ID重复

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId","2947297626687");
  10. request.putParam("vendorRecordId","R20200218135602565");
  11. request.putParam("plateNo", "苏B11111");
  12. request.putParam("plateColor", "BLUE");
  13. request.putParam("outTime", 1550034300000);
  14. request.put("outPictureUrl", "http://aliyun.com/parking.jpg");
  15. request.put("outChannelId", "C19008935");
  16. request.put("outChannelName", "天鹅座东门出口");
  17. # 停车场景能力业务参数,根据需要传参
  18. Map<String, JSONObject> bizParams = new HashMap<>();
  19. JSONObject bizParam1 = new JSONObject();
  20. bizParam1.put("alipayUserId", "2800437569838574893759327547");
  21. bizParams.put("LEAVEPAY", bizParam1);
  22. request.putParam("bizParams", JSON.toJSONString(bizParams));
  23. //请求参数域名、path、request
  24. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  25. "/park/isv/v1/park/record/depart", request);
  26. System.out.println("response code = " + response.getCode()
  27. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "2947297626687",
  5. "vendorRecordId": "R20200218135602565",
  6. "plateNo": "苏B11111",
  7. "plateColor": "BLUE",
  8. "outTime": 1550034300000,
  9. "outPictureUrl": "http://aliyun.com/parking.jpg",
  10. "outChannelId": "C19008935",
  11. "outChannelName": "天鹅座东门出口",
  12. "bizParams": "{
  13. \"LEAVEPAY\": {
  14. \"alipayUserId\": \"2800437569838574893759327547\"
  15. }
  16. }"
  17. },
  18. "request":{
  19. "apiVer":"1.0.0"
  20. },
  21. "version":"1.0"
  22. }

响应示例

  1. {
  2. "code": 200,
  3. "data": {
  4. "bizResults": "{
  5. \"LEAVEPAY\": {
  6. \"bizState\": 200,
  7. \"bizContent\": {
  8. }
  9. }
  10. }"
  11. },
  12. "message": "success"
  13. }

1.2.2.2.4 支付账单上传(可选)

概述

车辆离场完成成,实时将停车记录上传到云端。除了同步记录,还可以调用智能停车平台的云端能力进行更多业务处理,例如”先离场后付费”停车场景能力中的催缴通知,具体能力场景请参见停车场景能力文档。停车场库系统可以根据的业务需求选择性接入相应的停车场景能力。

接口

path: /park/isv/v1/park/bill/upload
version: 1.0.0

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 场库系统的停车场ID
vendorBillId String 64 场库系统场账单ID
vendorRecordId String 64 场库系统场账单ID对应的停车记录ID
plateNo String 16 车牌号,如果未识别传”无车牌”
chargeStartTime Long 计费开始时间,UTC时间(UNIX毫秒时间戳)
chargeEndTime Long 计费结束时间,UTC时间(UNIX毫秒时间戳)
billAmount Integer 账单计费金额,单位:分
receivableAmount Integer 账单应收金额(减去优惠后的),单位:分
paidAmount Integer 账单实收金额,单位:分
billCreateTime Long 账单生成时间,UTC时间(UNIX毫秒时间戳)
billPayTime Long 支付渠道返回的支付成功时间,UTC时间(UNIX毫秒时间戳)
payMethod String 支付方式:
- FREE : 免费
- BARCODE : 扫码付
- APP : APP付款
- ETC : ETC
- OTHER : 其他
payChannel String 支付渠道:
- CASH : 现金
- ETC : ETC
- ALIPAY : 支付宝
- WECHAT : 微信
- UNIONPAY : 银联


- CMB : 招商银行
- CCB : 建设银行
- FUYOU : 富友
- OTHER : 其他
|| payAccount | String | 否 | 128 | 支付渠道对应的支付账号,例如支付宝支付则传用户支付宝ID, 微信支持传用户OpenID || couponInfo | String | 否 | | 优惠信息,JSON结构 || bizParams | String | 否 | | 车场景能力业务参数,JSON字符串格式,相关说明参见车场景能力文档 || 业务响应参数: | | | | || 参数名称 | 参数类型 | 必填 | 长度 | 说明 || bizResults | String | 否 | | 车场景能力业务结果,JSON字符串格式,相关说明参见车场景能力文档 || | | | | |

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId","2947297626687");
  10. request.putParam("vendorBillId","90001");
  11. request.putParam("vendorRecordId","R20200218135602565");
  12. request.putParam("plateNo", "苏B11111");
  13. request.putParam("chargeStartTime", 1550030400000);
  14. request.putParam("chargeEndTime", 1550034500000);
  15. request.putParam("billAmount", 1000);
  16. request.putParam("reveivableAmount", 200);
  17. request.putParam("paidAmount", 200);
  18. request.putParam("billCreateTime", 1550034500000);
  19. request.putParam("billPayTime", 1550034500000);
  20. request.putParam("payMethod", "APP");
  21. request.putParam("payChannel", "ALIPAY");
  22. request.putParam("payAccount", "2800437569838574893759327547");
  23. request.putParam("couponInfo", "{\"couponId\": \"xbdgxv294bs\", \"amount\": 800}");
  24. //请求参数域名、path、request
  25. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  26. "/park/isv/v1/park/bill/upload", request);
  27. System.out.println("response code = " + response.getCode()
  28. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "2947297626687",
  5. "vendorBillId": "90001",
  6. "vendorRecordId": "R20200218135602565",
  7. "plateNo": "苏B11111",
  8. "chargeStartTime": 1550030400000,
  9. "chargeEndTime": 1550034500000,
  10. "billAmount": 1000,
  11. "reveivableAmount": 200,
  12. "paidAmount": 200,
  13. "billCreateTime": 1550034500000,
  14. "billPayTime": 1550034500000,
  15. "payMethod": "APP",
  16. "payChannel": "ALIPAY",
  17. "payAccount": "2800437569838574893759327547",
  18. "couponInfo": "{\"couponId\": \"xbdgxv294bs\", \"amount\": 800}"
  19. },
  20. "request":{
  21. "apiVer":"1.0.0"
  22. },
  23. "version":"1.0"
  24. }

响应示例

  1. {
  2. "code": 200,
  3. "data": {
  4. },
  5. "message": "success"
  6. }

1.2.2.2.5 进离场图片上传(可选)

概述

车辆进离场时将图片上传至云端。图片上传可能比较耗时,为保证进离场记录上报的实时性,停车管理系统可以先不带图片上报进离场记录,待图片上传完成后再调用本接口上传图片。

接口

path: /park/isv/v1/park/record/picture/upload
version: 1.0.0

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 场库系统的停车场ID
vendorRecordId String 64 场库系统场账单ID对应的停车记录ID
pictureUrl String 512 进离场图片URL
pictureType String 16 图片类型:
- IN : 入场图片
- OUT : 离场图片
业务响应参数:
参数名称 参数类型 必填 长度 说明
- - - - -

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId", "2947297626687");
  10. request.putParam("vendorRecordId", "R20200218135602565");
  11. request.putParam("pictureUrl", "http://aliyun.com/parking.jpg");
  12. request.putParam("pictureType", "IN");
  13. //请求参数域名、path、request
  14. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  15. "/park/isv/v1/park/record/picture/upload", request);
  16. System.out.println("response code = " + response.getCode()
  17. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "2947297626687",
  5. "vendorRecordId": "R20200218135602565",
  6. "pictureUrl": "http://aliyun.com/parking.jpg",
  7. "pictureType": "IN"
  8. },
  9. "request":{
  10. "apiVer":"1.0.0"
  11. },
  12. "version":"1.0"
  13. }

响应示例

  1. {
  2. "code": 200,
  3. "data": null,
  4. "message": "success"
  5. }
  1. {
  2. "code": 200,
  3. "data": {
  4. "serverTime": 1550030410000
  5. },
  6. "message": "success"
  7. }

1.2.2.3 停车场管理

1.2.2.3.1 创建停车场(必选)

概述

在阿里云智能停车平台创建新车场,停车场和停车厂商系统的停车场是一对一关联的。为保证一致性,停车厂商在创建停车场时,需要先调用本接口在阿里云停车平台创建停车场。
image.png

接口

path: /park/isv/v1/park/create
version: 1.0.1

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 停车厂商停车管理系统内停车场的标识ID
parkName String 64 停车场名称
address String 128 停车场地址
longitude Double 停车场位置经度 (高德坐标系)
latitude Double 停车场位置纬度 (高德坐标系)
totalSpace Integer 总车位数
parkEstateType String 32
停车场物业类型,枚举值如下:
- PUBLIC_PAKRING 公共停车场
- APPERTAIN_PARKING 配建停车场
- RESERVED_PARKING 专用停车场
parkBusinessType String 64 停车场商业类型,枚举值如下:
- OFFICE_BUILDING 写字楼
- RESIDENTIAL 小区
- HOSPITAL 医院
- PUBLIC_SERVICE 公共事业
- GOVERNMENT 政府机构
- TRANSPORTATION_HUB 交通枢纽
- SHOPPING_MALL 购物中心
- SPECIAL_USE 专用停车场
- RESTAURANT 餐饮
- ENTERTAINMENT 娱乐
- HOTEL 宾馆
- TOURISM 景点
- SCHOOL 学校
- EXHIBITION 场馆会展中心
- COMPREHENSIVE 综合
- UNKNOWN 未知
pictureUrls List 10 停车场图片URL,最多10张,第1张为主图
业务响应参数:
参数名称 参数类型 必填 长度 说明
- - - - -
业务异常:
异常码 说明
2003 厂商停车场ID已存在
2004 根据坐标经纬度找不到对应的地址

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId", "p23734375693");
  10. request.putParam("parkName", "天鹅座停车场");
  11. request.putParam("address", "无锡市新吴区净慧东路96号");
  12. request.putParam("longitude", 120.367013);
  13. request.putParam("latitude", 31.492141);
  14. request.putParam("totalSpace", 100);
  15. request.putParam("parkEstateType", "PUBLIC_PAKRING");
  16. request.putParam("parkBusinessType", "OFFICE_BUILDING");
  17. request.putParam("pictureUrls", ["http://aliyun.com/parking.jpg"]);
  18. //请求参数域名、path、request
  19. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  20. "/park/isv/v1/park/create", request);
  21. System.out.println("response code = " + response.getCode()
  22. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用
请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "p23734375693",
  5. "parkName": "天鹅座停车场",
  6. "address": "无锡市新吴区净慧东路96号",
  7. "longitude": 120.367013,
  8. "latitude": 31.492141,
  9. "totalSpace": 100,
  10. "parkEstateType": "PUBLIC_PAKRING",
  11. "parkBusinessType": "OFFICE_BUILDING",
  12. "pictureUrls": ["http://aliyun.com/parking.jpg"],
  13. },
  14. "request":{
  15. "apiVer":"1.0.0"
  16. },
  17. "version":"1.0"
  18. }

响应示例

  1. {
  2. "code": 200,
  3. "data": null,
  4. "message": "success"
  5. }

1.2.2.3.2 删除停车场(可选)

概述

删除阿里云智能停车平台停车场,合作伙伴删除停车场时需调用本接口,保存双方系统数据一致。

接口

path: /park/isv/v1/park/delete
version: 1.0.0

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 停车厂商停车管理系统内停车场的标识ID
业务响应参数:
参数名称 参数类型 必填 长度 说明
- - - - -
业务异常:
异常码 说明
2002 厂商停车场ID不存在

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId", "p23734375693");
  10. //请求参数域名、path、request
  11. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  12. "/park/isv/v1/park/delete", request);
  13. System.out.println("response code = " + response.getCode()
  14. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "p23734375693"
  5. },
  6. "request":{
  7. "apiVer":"1.0.0"
  8. },
  9. "version":"1.0"
  10. }

响应示例

  1. {
  2. "code": 200,
  3. "data": null,
  4. "message": "success"
  5. }

1.2.2.3.3 更新停车场(可选)

概述

更新阿里云智能停车平台停车场信息,合作伙伴修改停车场信息时需调用本接口,保存双方系统数据一致。

接口

path: /park/isv/v1/park/update
version: 1.0.0

参数

业务请求参数:
参数名称 参数类型 必填 长度 说明
vendorParkId String 64 停车厂商停车管理系统内停车场的标识ID
parkName String 64 停车场名称
address String 128 停车场地址
longitude Double 停车场位置经度 (高德坐标系)
latitude Double 停车场位置纬度 (高德坐标系)
totalSpace Integer 总车位数
parkEstateType String 32
停车场物业类型,枚举值如下:
- PUBLIC_PAKRING 公共停车场
- APPERTAIN_PARKING 配建停车场
- RESERVED_PARKING 专用停车场
parkBusinessType String 64 停车场商业类型,枚举值如下:
- OFFICE_BUILDING 写字楼
- RESIDENTIAL 小区
- HOSPITAL 医院
- PUBLIC_SERVICE 公共事业
- GOVERNMENT 政府机构
- TRANSPORTATION_HUB 交通枢纽
- SHOPPING_MALL 购物中心
- SPECIAL_USE 专用停车场
- RESTAURANT 餐饮
- ENTERTAINMENT 娱乐
- HOTEL 宾馆
- TOURISM 景点
- SCHOOL 学校
- EXHIBITION 场馆会展中心
- COMPREHENSIVE 综合
- UNKNOWN 未知
pictureUrls List 10 停车场图片URL,最多10张,第1张为主图
业务响应参数:
参数名称 参数类型 必填 长度 说明
- - - - -
业务异常:
异常码 说明
2002 厂商停车场ID不存在
2004 根据坐标经纬度找不到对应的地址

调用示例

Java SDK
  1. IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
  2. ioTApiClientBuilderParams.setAppKey("123456");
  3. ioTApiClientBuilderParams.setAppSecret("abcdefghijklmn");
  4. SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
  5. IoTApiRequest request = new IoTApiRequest();
  6. //设置api的版本
  7. request.setApiVer("1.0.0");
  8. // 接口参数
  9. request.putParam("vendorParkId", "p23734375693");
  10. request.putParam("parkName", "天鹅座停车场");
  11. request.putParam("address", "无锡市新吴区净慧东路96号");
  12. request.putParam("longitude", 120.367013);
  13. request.putParam("latitude", 31.492141);
  14. request.putParam("totalSpace", 100);
  15. request.putParam("parkEstateType", "PUBLIC_PAKRING");
  16. request.putParam("parkBusinessType", "OFFICE_BUILDING");
  17. request.putParam("pictureUrls", ["http://aliyun.com/parking.jpg"]);
  18. //请求参数域名、path、request
  19. ApiResponse response = syncApiClient.postBody("park-api-pre.aliplus.com",
  20. "/park/isv/v1/park/update", request);
  21. System.out.println("response code = " + response.getCode()
  22. + " response content = " + new String(response.getBody(), "utf-8"));

HTTP Client调用

请求示例

  1. {
  2. "id":"5e1c0fbc-acdb-4c47-9846-7fc9beedbe14",
  3. "params":{
  4. "vendorParkId": "p23734375693",
  5. "parkName": "天鹅座停车场",
  6. "address": "无锡市新吴区净慧东路96号",
  7. "longitude": 120.367013,
  8. "latitude": 31.492141,
  9. "totalSpace": 100,
  10. "parkEstateType": "PUBLIC_PAKRING",
  11. "parkBusinessType": "OFFICE_BUILDING",
  12. "pictureUrls": ["http://aliyun.com/parking.jpg"],
  13. },
  14. "request":{
  15. "apiVer":"1.0.0"
  16. },
  17. "version":"1.0"
  18. }

响应示例

  1. {
  2. "code": 200,
  3. "data": null,
  4. "message": "success"
  5. }