Files
jsowell-charger-web/doc/运营小程序接口文档.md
BOOL\25024 35b2367ab9 update
2024-09-09 09:53:52 +08:00

372 lines
17 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 查询站点的数据统计
```TEXT
接口地址http://localhost:8080/business/pile/station/getStationStatisticsInfos
请求方式POST
```
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------- | ------------ | -------- | ---------- |
| merchantId | String | N | 运营商id |
| stationIds | List<String> | N | 站点id列表 |
| startTime | String | N | 开始时间 |
| endTime | String | N | 结束时间 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------------- | --------------------------- | -------- | ---------------- |
| stationStatisticsInfos | List<StationStatisticsInfo> | Y | 站点统计信息集合 |
#### StationStatisticsInfo
| 字段名 | 类型 | 是否必传 | 备注 |
| --------------------- | ---------- | -------- | ----------------------- |
| stationId | String | Y | 站点id |
| stationName | String | Y | 站点名称 |
| chargeDegree | BigDecimal | Y | 充电度数(度) |
| chargeAmount | BigDecimal | Y | 充电总金额(元) |
| orderQuantity | Integer | Y | 订单数量(单) |
| connectorAvailability | String | Y | ==充电枪可使用率(%== |
| chargingConnectorNum | Integer | Y | 充电中(枪口数量) |
| freeConnectorNum | Integer | Y | 空闲(枪口数量) |
| occupiedConnectorNum | Integer | Y | 占用(枪口数量) |
| hangingConnectorNum | Integer | Y | 挂起(枪口数量) |
| offlineConnectorNum | Integer | Y | 离线(枪口数量) |
| faultConnectorNum | Integer | Y | 故障(枪口数量) |
<img src="C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20240723100712169.png" alt="image-20240723100712169" style="zoom: 25%;" />
# 站点经营分析统计图
```text
接口地址http://localhost:8080/business/pile/station/getStationBusinessAnalyzeInfo
接口地址(12个月数据)http://localhost:8080/business/pile/station/getStationMonthlyBusinessAnalyzeInfo
请求方式POST
```
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------- | ------------ | -------- | ------------------------------------------------------ |
| dateTime | String | N | 不传时默认查周期列表数据,传入时为用户选中某一天的日期 |
| type | String | N | 日期类型1-近7天2-近30天 |
| stationIds | List<String> | Y | 站点id列表 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------------------- | ------------------------------- | -------- | ------------------------ |
| electricityGrowthRate | String | Y | 充电量增长率 |
| orderAmountGrowthRate | String | Y | 订单金额增长率 |
| serviceAmountGrowthRate | String | Y | 服务费增长率 |
| businessOrderDetailInfoVOList | List<BusinessOrderDetailInfoVO> | N | 运营端小程序订单详情List |
| settleOrderReportList | List<SettleOrderReport> | N | 结算订单报表List |
#### businessOrderDetailInfoVO
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------------- | ---------- | -------- | -------------------- |
| tradeDate | String | Y | 交易日期(yyyy-MM-dd) |
| sharpUsedElectricity | BigDecimal | Y | 尖时段用电量 |
| sharpAmount | BigDecimal | Y | 尖时段总金额 |
| sharpElectricityPrice | BigDecimal | Y | 尖时段电费 |
| peakUsedElectricity | BigDecimal | Y | 峰时段用电量 |
| peakAmount | BigDecimal | Y | 峰时段总金额 |
| peakElectricityPrice | BigDecimal | Y | 峰时段电费 |
| flatUsedElectricity | BigDecimal | Y | 平时段用电量 |
| flatAmount | BigDecimal | Y | 平时段总金额 |
| flatElectricityPrice | BigDecimal | Y | 平时段电费 |
| valleyUsedElectricity | BigDecimal | Y | 谷时段用电量 |
| valleyAmount | BigDecimal | Y | 谷时段总金额 |
| valleyElectricityPrice | BigDecimal | Y | 谷时段电费 |
| totalServiceAmount | BigDecimal | Y | 总服务费 |
| settleAmount | BigDecimal | Y | 结算金额 |
| totalUsedElectricity | BigDecimal | Y | 总充电量 |
#### SettleOrderReport
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ---------- | -------- | ---------- |
| useElectricity | BigDecimal | Y | 用电度数 |
| totalAmount | BigDecimal | Y | 收入金额 |
| electricityAmount | BigDecimal | Y | 电费金额 |
| serviceAmount | BigDecimal | Y | 服务费金额 |
# 站点充点分布统计图
接口地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------------------- |
| | | Y | 时间(小时) |
| | | Y | 每个时段的充电量(度) |
| | | Y | 时段充电量同比增长率(% |
# 站点订单趋势统计图
```text
接口地址http://localhost:8080/business/pile/station/getStationOrderQuantityInfo
请求方式POST
```
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------- | ------------ | -------- | --------------------------------------- |
| stationIds | List<String> | Y | 站点id数组 |
| type | String | Y | 日期类型1-近7天2-近30天3-近一年) |
| dateTime | String | N | 用户选中某天的日期 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------------------- | ------------------------------ | -------- | --------------------------- |
| stationOrderQuantityInfoList | List<StationOrderQuantityInfo> | Y | 站点订单数量趋势信息 |
| orderNumRateGrowthRate | String | Y | 每天订单数量同比增长率(% |
### StationOrderQuantityInfo
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------- | ------ | -------- | -------- |
| tradeDate | String | Y | 交易日期 |
| orderNumber | int | Y | 订单数量 |
# 站点利用率趋势统计图
接口地址http://localhost:8080/business/pile/station/getStationConnectorUsedInfo
请求方式POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------- | ------------ | -------- | --------------------------------------- |
| stationIds | List<String> | Y | 站点id数组 |
| type | String | Y | 日期类型1-近7天2-近30天3-近一年) |
| dateTime | String | N | 用户选中某天的日期 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------------------- | ------------------------- | -------- | ---------------- |
| connectorUsedRiseRate | String | Y | 枪口利用率增长值 |
| List<BusinessOrderDetailInfoVO> | BusinessOrderDetailInfoVO | Y | 运营端订单详情 |
### BusinessOrderDetailInfoVO
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------------------------ |
| tradeDate | String | Y | 交易日期 |
| chargeNum | int | Y | 充电次数(枪口使用次数) |
# 站点充电实况列表
接口地址http://localhost:8080/business/pile/connector/getBusinessConnectorInfoList
请求方式POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| --------------- | ------- | -------- | ------------------------------------------------------------ |
| stationId | String | Y | 站点id |
| connectorStatus | String | N | 枪口状态0离网 1空闲2占用未充电3占用充电中4占用预约锁定即挂起 255故障 |
| pageNum | Integer | N | 页码 |
| pageSize | Integer | N | 每页条数 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------------- | ------------------------- | -------- | -------------- |
| | | Y | 站点名称 |
| connectorNum | Integer | Y | 全部枪口数量 |
| chargingConnectorNum | Integer | Y | 充电中枪口数量 |
| freeConnectorNum | Integer | Y | 空闲枪口数量 |
| hangingConnectorNum | Integer | Y | 挂起枪口数量 |
| occupiedConnectorNum | Integer | Y | 占用枪口数量 |
| offlineConnectorNum | Integer | Y | 离线枪口数量 |
| faultConnectorNum | Integer | Y | 故障枪口数量 |
| pileConnectorInfoVOList | List<PileConnectorInfoVO> | Y | 枪口信息数组 |
### PileConnectorInfoVO
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | -------------------------- |
| pileConnectorCode | String | Y | 充电枪编号 |
| SOC | String | Y | 充电中soc% |
| timeRemaining | String | Y | 充电中充满剩余时长(分钟) |
| chargingTime | String | Y | 已充时长 |
| faultReason | String | Y | 故障原因 |
# 站点充电实况搜索
接口地址http://localhost:8080/business/pile/connector/searchConnectorInfo
请求方式POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | ---------- |
| stationId | String | Y | 站点id |
| pileConnectorCode | String | Y | 充电枪编号 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | ---------- |
| pileConnectorCode | String | Y | 充电枪编号 |
| orderCode | String | N | 订单编号 |
| SOC | String | N | 充电百分比 |
| chargingTime | String | N | 已充时长 |
| timeRemaining | String | N | 剩余时长 |
# 充电枪情况
请求地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | -------- |
| pileConnectorCode | String | Y | 枪口编码 |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------------------------------------------- |
| | | Y | 已充时长(充电中) |
| | | Y | 最新订单启动时间 |
| | | Y | 充电度数(充电中:以充电度数 / 最新订单充电度数) |
| | | Y | 起止SOC |
# 充电枪情况中订单详情
请求地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | --------------------- |
| | | Y | 创建订单时间 |
| | | Y | 开始充电时间 |
| | | Y | 充电完成时间 |
| | | Y | 充电完成原因 |
| | | Y | 生成账单时间 |
| | | Y | 支付完成时间 |
| | | Y | 结算完成时间 |
| | | Y | 订单号 |
| | | Y | 场站名称 |
| | | Y | 订单来源 |
| | | Y | 外部订单号 |
| | | Y | 启动方式 |
| | | Y | 充电桩号 |
| | | Y | 充电枪口号 |
| | | Y | 结束SOC% |
| | | Y | 时长(分钟) |
| | | Y | 充电量(度) |
| | | Y | 停止原因 |
| | | Y | 占位符 |
| | | Y | 订单总额(元) |
| | | Y | 活动优惠金额(元) |
| | | Y | 优惠券金额(元) |
| | | Y | 其他优惠金额(元) |
| | | Y | 用户实付金额(元) |
| | | Y | 支付方式 |
| | List | Y | 收费明细 |
| | | Y | 用户信息 |
| | | Y | SOC、电流、电压统计图 |
### 收费明细
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------------------------------------------------------ |
| | | Y | 订单某个时段的时间截至2024-04-12 21:55:35 至 024-04-12 22:55:00 |
| | | Y | 当前时段的用电量(度) |
| | | Y | 当前时段的电费单价(元) |
| | | Y | 当前时段的服务费单价(元) |
| | | Y | 当前时段总价(元) |
### 用户信息
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | -------- |
| | | Y | 公司 |
| | | Y | 手机号 |
| | | Y | 车牌号 |
| | | Y | VIN码 |
| | | Y | 卡号 |
| | | Y | 车辆编号 |
| | | Y | 路线 |
### SOC、电流、电压统计图
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------- |
| | | Y | 时间 |
| | | Y | soc% |
| | | Y | 需求电流A |
| | | Y | 实际电流A |
| | | Y | 需求电压V |
| | | Y | 实际电压V |
1、在 ==站点管理== ——> ==运营管理== 中勾选浙江省平台,点击保存按钮
<img src="C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20240816100744446.png" alt="image-20240816100744446" style="zoom: 33%;" />
2、在 ==三方平台管理== ——> ==对接第三方平台关系== 页面中找到浙江省平台,点击 ==同步数据==,找到对应站点,点击 ==打开推送菜单== 页面, 点击右侧 ==推送充电站信息变化== 右侧的 ==推送== 按钮
<img src="C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20240816100551217.png" alt="image-20240816100551217" style="zoom: 50%;" />