autumn/jsowell-charger-web
1
0
Fork 0
mirror of https://codeup.aliyun.com/67c68d4e484ca2f0a13ac3c1/ydc/jsowell-charger-web.git synced 2026-04-19 18:45:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

修改接口文档，申请开票接口

Browse Source
This commit is contained in:
autumn.g@foxmail.com
2023-04-14 15:22:27 +08:00
parent 0a63c5044d
commit ed7f55ddad
7 changed files with 270 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

355
doc/接口文档New.md
View File

@@ -10,7 +10,7 @@
以下接口反参，指的是obj中的数据，接口返回都有resCode，msg，obj这三个字段。
### 示例
**示例**
~~~json
# 入参
@@ -67,7 +67,7 @@
}
~~~
# 会员接口
## 1001 登录注册接口
@@ -77,17 +77,17 @@
>
> 请求方式：GET
### 入参
**入参**
null，在Header中需传Authorization
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| -------- | ------ | -------- | ------------ |
| MemberVO | Object | Y | 用户信息对象 |
### MemberVO
**MemberVO**
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------ | ------ | -------- | --------------------------- |
@@ -109,7 +109,8 @@ null，在Header中需传Authorization
> 请求方式：POST
>
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------- | ------ | -------- | ---------------- |
| titleType | String | Y | 抬头类型（1-单位；2-个人）|
@@ -120,7 +121,7 @@ null，在Header中需传Authorization
| bankName | String | N | 开户银行 |
| bankAccountNumber | String | N | 银行账户 |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------ |
@@ -134,11 +135,12 @@ null，在Header中需传Authorization
> 请求方式：GET
>
### 入参
**入参**
null，在Header中需传Authorization
### 反参
**反参**
取obj中的list, 下面是list中对象字段信息
| 字段名 | 类型 | 是否必传 | 备注 |
@@ -148,13 +150,100 @@ null，在Header中需传Authorization
| titleType | String | Y | 抬头类型 （单位或个人） |
## 1006 查询余额明细
> 请求地址： http://localhost:8080/uniapp/member/getMemberBalanceChanges
>
> 请求方式：POST
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------- | ------ | -------- | ------------------------ |
| memberToken | String | Y | 会员令牌 |
| type | String | Y | 交易类型 1-进账；2-出账 |
| pageSize | | | |
| pageNum | | | |
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------ | ------ | -------- | -------------------------- |
| memberId | String | Y | 会员Id |
| principalBalance | Number | Y | 当前账户本金余额 |
| giftBalance | Number | Y | 当前账户赠送余额 |
| totalAccountAmount | Number | Y | 账户总余额 |
| type | String | Y | 交易类型 1-进账；2-出账 |
| subType | String | Y | 子类型 |
| amount | String | Y | 出账/入账金额 |
| transactionTime | String | Y | 交易时间 |
| category | String | Y | 余额类型（1-本金，2-赠送） |
## 1007 通过 memberId 查询用户个人基本信息(查询用户是否已绑定车牌号)
> 请求地址： http://localhost:8080/uniapp/member/getMemberCarNoInfo
>
> 请求方式：GET
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------ | ------ | -------- | -------- |
| memberId | String | Y | 会员id |
| phoneNumber | String | Y | 手机号码 |
| licensePlateNumber | String | Y | 车牌号 |
| createTime | String | Y | 创建时间 |
## 1008 用户绑定车牌号
> 请求地址：http://localhost:8080/uniapp/member/memberBindingCarNo
>
> 请求方式：POST
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------- | ------ | -------- | ---------- |
| phoneNumber | String | Y | 手机号码 |
| verificationCode | String | Y | 短信验证码 |
| carNo | String | Y | 车牌号 |
## 1009 用户（批量）解绑车牌号
> 请求地址：http://localhost:8080/uniapp/member/memberUnbindCarNo
>
> 请求方式：POST
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ------------- | -------- | -------------- |
| id | List<Integer> | Y | 要删除的Id集合 |
**反参**
会在 “obj” 中返回解绑的条数
# 充电站接口
## 2001 根据经纬度查询充电站列表（分页排序）
> 接口地址：http://localhost:8080/uniapp/pile/queryStationInfos
>
> 请求类型：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------- | ------ | -------- | ---------------- |
@@ -164,7 +253,7 @@ null，在Header中需传Authorization
| pageSize | Number | Y | 每页数量 |
| stationName | String | y | 站点名称（搜索） |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| -------- | ---------------- | -------- | ---------- |
@@ -193,14 +282,21 @@ StationVO
| stationLng | String | Y | 经度 |
| stationLat | String | Y | 纬度 |
# 充电桩接口
## 3001 查询充电桩详情
## 3002 查询充电桩枪口详情
> 接口地址：http://localhost:8080/uniapp/pile/selectConnectorListByParams
>
> 请求类型：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------------- | -------- | --------------------------- |
@@ -212,7 +308,7 @@ StationVO
| connectorIdList | Array<Long> | N | 枪口id列表 |
| connectorCodeList | Array<String> | N | 枪口号列表 |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| -------- | -------------------------- | -------- | ------------ |
@@ -222,7 +318,7 @@ StationVO
| total | Number | Y | 总数 |
| pages | Number | Y | 总页数 |
### PileConnectorInfoVO
**PileConnectorInfoVO**
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------ | ---------- | :------: | ------------------------------------------------------------ |
@@ -251,7 +347,7 @@ StationVO
| chargingDegree | BigDecimal | Y | 充电度数 |
| businessType | | y | 经营类型（1-运营桩；2-个人桩） |
### 示例：
**示例：**
```json
#入参：
@@ -301,13 +397,15 @@ StationVO
}
```
## 3003 站点详情页面
接口地址：
请求方式：
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ---- | -------- | ------ |
@@ -315,7 +413,7 @@ StationVO
| | | | |
| | | | |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------- | ---- | -------- | -------- |
@@ -334,13 +432,15 @@ StationVO
## 4001 启动充电
# 订单接口
## 5001 生成订单
> 接口地址：http://localhost:8080/uniapp/order/generateOrder
>
> 请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | --------------------------- |
@@ -351,14 +451,9 @@ StationVO
备注：pileSn + connectorCode 或 pileConnectorCode 选其一，接口都支持
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------ |
| orderCode | String | Y | 订单号 |
**反参**
```
## 4002 结束充电
> 接口地址：http://localhost:8080/uniapp/order/settleOrder
@@ -377,23 +472,70 @@ StationVO
### 反参
null，若成功，msg中会有“==操作成功==”提示
```
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------ |
| orderCode | String | Y | 订单号 |
## 5001 查询订单列表
## 5002 支付订单
> 请求地址：http://localhost:8080/uniapp/pay/payOrder
>
> 请求方式：POST
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | -------- |
| orderCode | String | Y | 订单号 |
| payMode | String | Y | 支付方式 |
| payAmount | String | Y | 支付金额 |
**反参**
null，提示”==操作成功==“
## 5003 结算订单
> 接口地址：http://localhost:8080/uniapp/order/settleOrder
>
> 请求方式：POST
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | --------------------------- |
| orderCode | String | Y | 订单号 |
| pileSn | String | Y | 桩编码 |
| connectorCode | String | Y | 枪口号 |
| pileConnectorCode | String | Y | 桩枪口编号（桩编码+枪口号） |
**反参**
null，若成功，msg中会有“==操作成功==”提示
## 5004 查询订单列表
> 请求地址：http://localhost:8080/uniapp/order/getOrderList
>
> 请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | --------------------------- |
| memberId | String | Y | 会员id |
| pageSize | Number | Y | |
| pageNum | Number | Y | |
| orderStatus | String | Y | 订单状态 1-全部 2-未完成 3-已完成 |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | --------------------------- |
@@ -411,93 +553,21 @@ null，若成功，msg中会有“==操作成功==”提示
| payStatus | String | Y | 支付状态(0-待支付；1-支付完成) |
| reason | String | Y | 订单异常原因 |
## 60001 查询余额明细
> 请求地址： http://localhost:8080/uniapp/member/getMemberBalanceChanges
>
> 请求方式：POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------- | ------ | -------- | ------------------------ |
| memberToken | String | Y | 会员令牌 |
| type | String | Y | 交易类型 1-进账；2-出账 |
| pageSize | | | |
| pageNum | | | |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------ | ------ | -------- | -------------------------- |
| memberId | String | Y | 会员Id |
| principalBalance | Number | Y | 当前账户本金余额 |
| giftBalance | Number | Y | 当前账户赠送余额 |
| totalAccountAmount | Number | Y | 账户总余额 |
| type | String | Y | 交易类型 1-进账；2-出账 |
| subType | String | Y | 子类型 |
| amount | String | Y | 出账/入账金额 |
| transactionTime | String | Y | 交易时间 |
| category | String | Y | 余额类型（1-本金，2-赠送） |
## 7001 生成订单
> 请求地址：http://localhost:8080/uniapp/order/generateOrder
>
> 请求方式：POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | ---------- |
| pileConnectorCode | String | Y | 桩枪口编码 |
| chargeAmount | Number | Y | 充电金额 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------ |
| orderCode | String | Y | 订单号 |
## 7002 支付订单
> 请求地址：http://localhost:8080/uniapp/pay/payOrder
>
> 请求方式：POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | -------- |
| orderCode | String | Y | 订单号 |
| payMode | String | Y | 支付方式 |
| payAmount | String | Y | 支付金额 |
### 反参
null，提示”==操作成功==“
## 7003 订单停止充电
## 5005 订单停止充电
> 请求地址：http://localhost:8080/uniapp/order/stopCharging
>
> 请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------ |
| orderCode | String | Y | 订单号 |
### 反参
**反参**
null，提示”==操作成功==“
@@ -515,13 +585,13 @@ null，提示”==操作成功==“
>
> 请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------ |
| stationId | String | N | 站点id |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| --------------------- | ------ | -------- | ---------- |
@@ -539,13 +609,13 @@ null，提示”==操作成功==“
>
> 请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| --------- | ------ | -------- | ------ |
| stationId | String | N | 站点id |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| -------------------------- | ------ | -------- | -------------- |
@@ -567,7 +637,7 @@ null，提示”==操作成功==“
>
> 请求方式： POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------- | ------ | -------- | -------------- |
@@ -575,7 +645,7 @@ null，提示”==操作成功==“
| phoneNumber | String | Y | 用户手机号码 |
| verificationCode | String | Y | 用户手机验证码 |
### 反参
**反参**
@@ -587,7 +657,7 @@ null，提示”==操作成功==“
>
> 请求方式： POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------- | ------ | -------- | -------------------- |
@@ -602,9 +672,9 @@ null，提示”==操作成功==“
>
> 请求方式： GET
### 反参
**反参**
### List<PersonalPileInfoVO>
**List<PersonalPileInfoVO>**
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------ | ------ | -------- | ---------------------------- |
@@ -628,13 +698,13 @@ null，提示”==操作成功==“
>
> 请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | -------- |
| pileConnectorCode | String | Y | 桩枪口号 |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| -------------- | ------ | -------- | -------- |
@@ -650,7 +720,7 @@ null，提示”==操作成功==“
>
> 请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | -------- |
@@ -658,7 +728,7 @@ null，提示”==操作成功==“
| startTime | String | Y | 开始日期 |
| endTime | String | Y | 结束日期 |
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------------- | ------ | -------- | ------------ |
@@ -676,7 +746,7 @@ null，提示”==操作成功==“
请求方式：POST
### 入参
**入参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ------ | -------- | -------- |
@@ -686,7 +756,7 @@ null，提示”==操作成功==“
### 反参
**反参**
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------- | ------ | -------- | -------- |
@@ -695,50 +765,3 @@ null，提示”==操作成功==“
| chargingElectricity | String | Y | 用电量 |
| chargingTime | String | Y | 充电时长 |
## 10001 通过 memberId 查询用户个人基本信息(查询用户是否已绑定车牌号)
> 请求地址： http://localhost:8080/uniapp/member/getMemberCarNoInfo
>
> 请求方式：GET
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------------------ | ------ | -------- | -------- |
| memberId | String | Y | 会员id |
| phoneNumber | String | Y | 手机号码 |
| licensePlateNumber | String | Y | 车牌号 |
| createTime | String | Y | 创建时间 |
## 10002 用户绑定车牌号
> 请求地址：http://localhost:8080/uniapp/member/memberBindingCarNo
>
> 请求方式：POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------- | ------ | -------- | ---------- |
| phoneNumber | String | Y | 手机号码 |
| verificationCode | String | Y | 短信验证码 |
| carNo | String | Y | 车牌号 |
## 10003 用户（批量）解绑车牌号
> 请求地址：http://localhost:8080/uniapp/member/memberUnbindCarNo
>
> 请求方式：POST
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ------------- | -------- | -------------- |
| id | List<Integer> | Y | 要删除的Id集合 |
### 反参
会在 “obj” 中返回解绑的条数