| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
v2025-10-09 09:54:22 | 2025-10-09 09:54:22 | auto | @root | Created by smart-doc |
1.风险检测移动端
1.1.推广佣金
1.1.1.佣金统计
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 佣金统计
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
includeTodayIn | boolean | 是否统计本日收入，默认false | false | - | true |
includeCurWeekIn | boolean | 是否统计本周收入，默认false | false | - | true |
includeCurMonthIn | boolean | 是否统计本月收入，默认false | false | - | true |
includeLastMonthIn | boolean | 是否统计上月收入，默认false | false | - | true |
includeCurYearIn | boolean | 是否统计本年收入，默认false | false | - | true |
includeWithdrawing | boolean | 是否统计提现中金额，默认false | false | - | true |
includeTotalWithdrew | boolean | 是否统计累计提现金额，默认false | false | - | true |
includeToneUpIn | boolean | 是否统计邀请下级收益 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/spreadStatistics' --data '{
"includeTodayIn": true,
"includeCurWeekIn": true,
"includeCurMonthIn": true,
"includeLastMonthIn": true,
"includeCurYearIn": true,
"includeWithdrawing": true,
"includeTotalWithdrew": true,
"includeToneUpIn": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─accountId | int64 | 佣金账户id | - | 0 |
└─userId | int64 | 用户id | - | 0 |
└─totalInAmount | number | 累计收入 | - | 0 |
└─operableAmount | number | 可提现金额 | - | 0 |
└─residualAmount | number | 剩余佣金(包括待结算) | - | 0 |
└─totalDeductAmount | number | 累计扣除金额 | - | 0 |
└─todayCount | int64 | 今日数量 | - | 0 |
└─todayInAmount | number | 今日收入 | - | 0 |
└─curWeekCount | int64 | 本周数量 | - | 0 |
└─curWeekInAmount | number | 本周收入 | - | 0 |
└─curMonthCount | int64 | 本月数量 | - | 0 |
└─curMonthInAmount | number | 本月收入 | - | 0 |
└─lastMonthCount | int64 | 上月数量 | - | 0 |
└─lastMonthInAmount | number | 上月收入 | - | 0 |
└─curYearCount | int64 | 本年数量 | - | 0 |
└─curYearInAmount | number | 本年收入 | - | 0 |
└─toneUpInCount | int64 | 邀请下级收益次数 | - | 0 |
└─toneUpInAmount | number | 邀请下级收益金额 | - | 0 |
└─withdrawingCount | int64 | 提现中数量 | - | 0 |
└─withdrawingAmount | number | 提现中金额 | - | 0 |
└─totalWithdrewCount | int64 | 累计提现次数 | - | 0 |
└─totalWithdrewAmount | number | 累计提现金额 | - | 0 |
└─totalOrderCount | int32 | 是否累计销售次数（不包括下级开单） | - | 0 |
└─totalInvitedCount | int32 | 已邀好友 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"accountId": 0,
"userId": 0,
"totalInAmount": 0,
"operableAmount": 0,
"residualAmount": 0,
"totalDeductAmount": 0,
"todayCount": 0,
"todayInAmount": 0,
"curWeekCount": 0,
"curWeekInAmount": 0,
"curMonthCount": 0,
"curMonthInAmount": 0,
"lastMonthCount": 0,
"lastMonthInAmount": 0,
"curYearCount": 0,
"curYearInAmount": 0,
"toneUpInCount": 0,
"toneUpInAmount": 0,
"withdrawingCount": 0,
"withdrawingAmount": 0,
"totalWithdrewCount": 0,
"totalWithdrewAmount": 0,
"totalOrderCount": 0,
"totalInvitedCount": 0
},
"timestamp": 0,
"traceId": ""
}1.1.2.查询佣金记录
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 查询佣金记录
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
stateList | array | 状态，-5：已扣除，-1:已取消，0-待生效，10-待结算，20-已结算 | false | - | "0,0" |
createTimeGte | string | 创建时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 创建时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
deductTimeGte | string | 扣除时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
deductTimeLte | string | 扣除时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
isDirect | boolean | 是否直接推广收益，true:是，false:邀请下级收益 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"stateList": [
0
],
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss",
"deductTimeGte": "yyyy-MM-dd HH:mm:ss",
"deductTimeLte": "yyyy-MM-dd HH:mm:ss",
"isDirect": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─accountId | int64 | 佣金账户id | - | 0 |
└─userId | int64 | 用户id | - | 0 |
└─orderNo | string | 业务订单号 | - | |
└─orderAmount | number | 订单金额 | - | 0 |
└─totalSplitAmount | number | 总分佣金额 | - | 0 |
└─brokerageRate | number | 佣金比例 | - | 0 |
└─brokerageAmount | number | 佣金 | - | 0 |
└─state | int32 | 状态 | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─directUserInfo | string | 推广代理信息，姓名 + 手机号脱敏 | - | |
└─autoSettle | boolean | 是否自动结算 | - | true |
└─settleTime | string | 结算时间 | - | yyyy-MM-dd HH:mm:ss |
└─deductTime | string | 扣除时间 | - | yyyy-MM-dd HH:mm:ss |
└─description | string | 描述 | - | |
└─extra | string | 扩展数据 | - | |
└─name | string | 姓名 | - | |
└─mobile | string | 手机号 | - | |
└─refundAmount | number | 退款金额 | - | 0 |
└─refundTime | string | 退款时间 | - | yyyy-MM-dd HH:mm:ss |
└─disputeType | string | 订单争议类型 | - | |
└─surveyObject | string | 查询对象 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"accountId": 0,
"userId": 0,
"orderNo": "",
"orderAmount": 0,
"totalSplitAmount": 0,
"brokerageRate": 0,
"brokerageAmount": 0,
"state": 0,
"directUserId": 0,
"directUserInfo": "",
"autoSettle": true,
"settleTime": "yyyy-MM-dd HH:mm:ss",
"deductTime": "yyyy-MM-dd HH:mm:ss",
"description": "",
"extra": "",
"name": "",
"mobile": "",
"refundAmount": 0,
"refundTime": "yyyy-MM-dd HH:mm:ss",
"disputeType": "",
"surveyObject": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.1.3.查询佣金提现配置
Type: GET
Author: wangqidong created on 2024/7/4
Content-Type: application/x-www-form-urlencoded
Description: 查询佣金提现配置
Request-example:
curl -X GET -i '/dex/rs/mini/spread/queryWithdrawConfig'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─onceMin | number | 单次最低提现金额 | - | 0 |
└─onceMax | number | 单次最高提现金额 | - | 0 |
└─dailyMax | number | 每日最高提现金额（无需审核） | - | 0 |
└─dailyMaxCount | int32 | 单日最高申请次数 | - | 0 |
└─enableAudit | boolean | 是否启用审核 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"onceMin": 0,
"onceMax": 0,
"dailyMax": 0,
"dailyMaxCount": 0,
"enableAudit": true
},
"timestamp": 0,
"traceId": ""
}1.1.4.申请提现
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 申请提现
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
amount | number | 提现金额 | true | - | 0 |
withdrawType | enum | 提现方式 | true | - | WALLET |
toAccount | string | 提现账户 wechat：公众号或小程序绑定的openid（不需要传） alipay：支付宝账号 bankCard: 银行卡号 | false | - | |
accountName | string | 银行名称等 | false | - | |
realName | string | 姓名，支付宝、银行卡可能需要实名校验 | false | - | |
remark | string | 备注 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/withdrawApply' --data '{
"amount": 0,
"withdrawType": "",
"toAccount": "",
"accountName": "",
"realName": "",
"remark": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─withdrawNo | string | 提现单号 | - | |
└─isWithdrew | boolean | 是否提现成功 | - | true |
└─state | int32 | 提现状态 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"withdrawNo": "",
"isWithdrew": true,
"state": 0
},
"timestamp": 0,
"traceId": ""
}1.1.5.提现记录
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 提现记录
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
withdrawType | string | 提现方式 | false | - | |
stateList | array | 提现状态 | false | - | "0,0" |
finishTimeGte | string | 提现完成时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
finishTimeLte | string | 提现完成时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeGte | string | 创建完成时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 创建完成时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/withdrawList' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"withdrawType": "",
"stateList": [
0
],
"finishTimeGte": "yyyy-MM-dd HH:mm:ss",
"finishTimeLte": "yyyy-MM-dd HH:mm:ss",
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─withdrawNo | string | 提现单号 | - | |
└─userId | int64 | 用户id | - | 0 |
└─withdrawType | string | 提现方式 | - | |
└─withdrawAmount | number | 提现金额 | - | 0 |
└─state | int32 | 提现状态 | - | 0 |
└─auditMode | string | 审核方式，system-系统，manual-人工 | - | |
└─rejectReason | string | 驳回原因 | - | |
└─finishTime | string | 提现完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─remark | string | 备注 | - | |
└─toAccount | string | 提现账户 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"withdrawNo": "",
"userId": 0,
"withdrawType": "",
"withdrawAmount": 0,
"state": 0,
"auditMode": "",
"rejectReason": "",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"remark": "",
"toAccount": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.1.6.获取模板推广地址
Type: GET
Author: wangqidong created on 2024/7/4
Content-Type: application/x-www-form-urlencoded
Description: 获取模板推广地址
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | No comments found. | true | - |
Request-example:
curl -X GET -i '/dex/rs/mini/spread/getTemplateSpreadUrl/{templateCode}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─spreadUrl | string | 推广链接 | - | |
└─logo | string | Logo | - | |
└─qrCodeUrl | string | 推广二维码 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"spreadUrl": "",
"logo": "",
"qrCodeUrl": ""
},
"timestamp": 0,
"traceId": ""
}1.1.7.我的代理列表
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 我的代理列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/mineAgents' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─userId | int64 | No comments found. | - | 0 |
└─name | string | 姓名 | - | |
└─mobile | string | 手机号 | - | |
└─orderCount | int32 | 订单量 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─splitCount | int64 | 分佣次数 | - | 0 |
└─brokerageAmountSum | number | 分佣金额合计 | - | 0 |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"userId": 0,
"name": "",
"mobile": "",
"orderCount": 0,
"orderAmount": 0,
"splitCount": 0,
"brokerageAmountSum": 0
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.1.8.下级排行
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 下级排行
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
queryRange | string | 查询范围 ALL：全部 TD：今天 YD：昨天 CW：本周 LW：上周 CM：本月 LM：上月 CY：本年 LY：去年 N3D：近3天 N7D：近7天 N1H：1小时内 N3H：3小时内 N6H：6小时内 N12H：12小时内 N1W：近1周 N2W：近2周 N3W：近3周 N1M：近1月 N2M：近2月 N3M：近3月 N1Y：近1年 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/subRanking' --data '{
"queryRange": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─subUserId | int64 | 用户id | - | 0 |
└─subName | string | 下级姓名 | - | |
└─subMobile | string | 下级手机号 | - | |
└─splitCount | int64 | 分佣次数 | - | 0 |
└─brokerageAmountSum | number | 分佣金额合计 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"subUserId": 0,
"subName": "",
"subMobile": "",
"splitCount": 0,
"brokerageAmountSum": 0
}
],
"timestamp": 0,
"traceId": ""
}1.1.9.计算成本价
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 计算成本价
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - | |
salesPrice | number | 销售价 | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/calculateCostPrice' --data '{
"templateCode": "",
"salesPrice": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | number | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": 0,
"timestamp": 0,
"traceId": ""
}1.1.10.查询下级价格
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 查询下级价格
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | false | - | |
subUserIds | array | 下级用户id | false | - | "0,0" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/querySubAgentPrice' --data '{
"templateCode": "",
"subUserIds": [
0
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─subUserId | int64 | 下级用户id | - | 0 |
└─name | string | 姓名 | - | |
└─mobile | string | 手机号 | - | |
└─templateList | array | 模板价格明细 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─userId | int64 | 所属用户id | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─salesPrice | number | 销售价 | - | 0 |
└─costPrice | number | 成本价 | - | 0 |
└─upperRoyalty | number | 上级收益 | - | 0 |
└─maxEditablePrice | number | 最大可设置的价格 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"subUserId": 0,
"name": "",
"mobile": "",
"templateList": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"userId": 0,
"templateCode": "",
"templateName": "",
"salesPrice": 0,
"costPrice": 0,
"upperRoyalty": 0,
"maxEditablePrice": 0,
"basePoint": 0
}
]
}
],
"timestamp": 0,
"traceId": ""
}1.1.11.修改下级代理收益
Type: POST
Author: wangqidong created on 2024/7/4
Content-Type: application/json
Description: 修改下级代理收益
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
subUserId | int64 | 下级用户id | true | - | 0 |
templateList | array | 模板价格明细 | true | - | |
└─templateCode | string | 模板编码 | true | - | |
└─upperRoyalty | number | 上级收益 | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/spread/editSubAgentRoyalty' --data '{
"subUserId": 0,
"templateList": [
{
"templateCode": "",
"upperRoyalty": 0
}
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.2.客户投诉
1.2.1.发起投诉
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 发起投诉
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
complaintType | string | 投诉类型 | false | - | |
complaintContent | string | 投诉内容 | true | - | |
complaintImgList | array | 投诉证明照片，多个逗号分割 | false | - | """,""" |
complaintAmount | number | 投诉金额 | false | - | 0 |
linkMobile | string | 联系方式 | false | - | |
details | array | 订单明细 | true | - | |
└─orderNo | string | 订单号 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/complaint/submit' --data '{
"complaintType": "",
"complaintContent": "",
"complaintImgList": [
""
],
"complaintAmount": 0,
"linkMobile": "",
"details": [
{
"orderNo": ""
}
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.2.2.撤诉
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 撤诉
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
complaintIds | array | 投诉单号 | true | - | "0,0" |
remark | string | 备注 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/complaint/drop' --data '{
"complaintIds": [
0
],
"remark": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.2.3.我发起的投诉列表
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 我发起的投诉列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
keyword | string | 搜索关键字 | false | - | |
channel | string | 投诉渠道 | false | - | |
stateList | array | 状态 | false | - | "0,0" |
isPlatProcess | boolean | 是否平台处理 | false | - | true |
createTimeGte | string | 发起投诉时间起始时间 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 发起投诉时间截止时间 | false | - | yyyy-MM-dd HH:mm:ss |
effectTimeGte | string | 投诉生效时间起始时间 | false | - | yyyy-MM-dd HH:mm:ss |
effectTimeLte | string | 投诉生效时间截止时间 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/complaint/accuserList' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"keyword": "",
"channel": "",
"stateList": [
0
],
"isPlatProcess": true,
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss",
"effectTimeGte": "yyyy-MM-dd HH:mm:ss",
"effectTimeLte": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─channel | string | 投诉渠道，plat：平台投诉，alipay：支付宝，wechat：微信 | - | |
└─mobile | string | 投诉人手机号 | - | |
└─complaintType | string | 投诉类型 | - | |
└─complaintContent | string | 投诉内容 | - | |
└─complaintImgList | array | 投诉证明照片，多个逗号分割 | - | """,""" |
└─orderCount | int32 | 订单数量 | - | 0 |
└─currUserOrderCount | int32 | 当前查询用户关联订单数量 | - | 0 |
└─state | int32 | 状态 | - | 0 |
└─effectTime | string | 投诉生效时间 | - | yyyy-MM-dd HH:mm:ss |
└─processEndTime | string | 处理截止时间，超时平台将自动处理 | - | yyyy-MM-dd HH:mm:ss |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─complaintAmount | number | 投诉金额 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额（包含上级佣金） | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─thirdId | string | 第三方投诉单id | - | |
└─linkMobile | string | 联系方式 | - | |
└─auditRemark | string | 审核备注 | - | |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─details | array | 明细，详情接口才会返回 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─complaintId | int64 | 投诉单id | - | 0 |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─userId | int64 | 用户id（代理id） | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─thirdTradeNo | string | 第三方交易单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─refundFlag | int32 | 退款标识，0-未处理，10-无需退款，20-已退款 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额 | - | 0 |
└─directBrokerage | number | 直接上级佣金 | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─processType | string | 处理类型 | - | |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─agentInfo | string | 代理信息 | - | |
└─surveyObject | string | 查询对象 | - | |
└─orderCreateTime | string | 订单创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"channel": "",
"mobile": "",
"complaintType": "",
"complaintContent": "",
"complaintImgList": [
""
],
"orderCount": 0,
"currUserOrderCount": 0,
"state": 0,
"effectTime": "yyyy-MM-dd HH:mm:ss",
"processEndTime": "yyyy-MM-dd HH:mm:ss",
"processTime": "yyyy-MM-dd HH:mm:ss",
"isPlatProcess": true,
"complaintAmount": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"refundAmount": 0,
"thirdId": "",
"linkMobile": "",
"auditRemark": "",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"details": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"complaintId": 0,
"orderNo": "",
"payNo": "",
"userId": 0,
"templateCode": "",
"templateName": "",
"thirdTradeNo": "",
"state": 0,
"isPlatProcess": true,
"refundFlag": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"directBrokerage": 0,
"refundAmount": 0,
"processType": "",
"processTime": "yyyy-MM-dd HH:mm:ss",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"surveyType": 0,
"agentInfo": "",
"surveyObject": "",
"orderCreateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.2.4.代理客诉列表
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 代理客诉列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
keyword | string | 搜索关键字 | false | - | |
channel | string | 投诉渠道 | false | - | |
stateList | array | 状态 | false | - | "0,0" |
isPlatProcess | boolean | 是否平台处理 | false | - | true |
createTimeGte | string | 发起投诉时间起始时间 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 发起投诉时间截止时间 | false | - | yyyy-MM-dd HH:mm:ss |
effectTimeGte | string | 投诉生效时间起始时间 | false | - | yyyy-MM-dd HH:mm:ss |
effectTimeLte | string | 投诉生效时间截止时间 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/complaint/accusedList' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"keyword": "",
"channel": "",
"stateList": [
0
],
"isPlatProcess": true,
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss",
"effectTimeGte": "yyyy-MM-dd HH:mm:ss",
"effectTimeLte": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─complaintId | int64 | 投诉单id | - | 0 |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─userId | int64 | 用户id（代理id） | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─thirdTradeNo | string | 第三方交易单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─refundFlag | int32 | 退款标识，0-未处理，10-无需退款，20-已退款 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额 | - | 0 |
└─directBrokerage | number | 直接上级佣金 | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─processType | string | 处理类型 | - | |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─agentInfo | string | 代理信息 | - | |
└─surveyObject | string | 查询对象 | - | |
└─orderCreateTime | string | 订单创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─channel | string | 投诉渠道，plat：平台投诉，alipay：支付宝，wechat：微信 | - | |
└─mobile | string | 投诉人手机号 | - | |
└─complaintType | string | 投诉类型 | - | |
└─complaintContent | string | 投诉内容 | - | |
└─complaintImgList | array | 投诉证明照片，多个逗号分割 | - | """,""" |
└─orderCount | int32 | 订单数量 | - | 0 |
└─effectTime | string | 投诉生效时间 | - | yyyy-MM-dd HH:mm:ss |
└─processEndTime | string | 处理截止时间，超时平台将自动处理 | - | yyyy-MM-dd HH:mm:ss |
└─thirdId | string | 第三方投诉单id | - | |
└─linkMobile | string | 联系方式 | - | |
└─auditRemark | string | 审核备注 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"complaintId": 0,
"orderNo": "",
"payNo": "",
"userId": 0,
"templateCode": "",
"templateName": "",
"thirdTradeNo": "",
"state": 0,
"isPlatProcess": true,
"refundFlag": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"directBrokerage": 0,
"refundAmount": 0,
"processType": "",
"processTime": "yyyy-MM-dd HH:mm:ss",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"surveyType": 0,
"agentInfo": "",
"surveyObject": "",
"orderCreateTime": "yyyy-MM-dd HH:mm:ss",
"channel": "",
"mobile": "",
"complaintType": "",
"complaintContent": "",
"complaintImgList": [
""
],
"orderCount": 0,
"effectTime": "yyyy-MM-dd HH:mm:ss",
"processEndTime": "yyyy-MM-dd HH:mm:ss",
"thirdId": "",
"linkMobile": "",
"auditRemark": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.2.5.客诉详情
Type: GET
Author: wangqidong created on 2025/5/16
Content-Type: application/x-www-form-urlencoded
Description: 客诉详情
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
complaintId | int64 | No comments found. | true | - | 0 |
Request-example:
curl -X GET -i '/dex/rs/mini/complaint/detail/{complaintId}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─channel | string | 投诉渠道，plat：平台投诉，alipay：支付宝，wechat：微信 | - | |
└─mobile | string | 投诉人手机号 | - | |
└─complaintType | string | 投诉类型 | - | |
└─complaintContent | string | 投诉内容 | - | |
└─complaintImgList | array | 投诉证明照片，多个逗号分割 | - | """,""" |
└─orderCount | int32 | 订单数量 | - | 0 |
└─currUserOrderCount | int32 | 当前查询用户关联订单数量 | - | 0 |
└─state | int32 | 状态 | - | 0 |
└─effectTime | string | 投诉生效时间 | - | yyyy-MM-dd HH:mm:ss |
└─processEndTime | string | 处理截止时间，超时平台将自动处理 | - | yyyy-MM-dd HH:mm:ss |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─complaintAmount | number | 投诉金额 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额（包含上级佣金） | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─thirdId | string | 第三方投诉单id | - | |
└─linkMobile | string | 联系方式 | - | |
└─auditRemark | string | 审核备注 | - | |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─details | array | 明细，详情接口才会返回 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─complaintId | int64 | 投诉单id | - | 0 |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─userId | int64 | 用户id（代理id） | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─thirdTradeNo | string | 第三方交易单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─refundFlag | int32 | 退款标识，0-未处理，10-无需退款，20-已退款 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额 | - | 0 |
└─directBrokerage | number | 直接上级佣金 | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─processType | string | 处理类型 | - | |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─agentInfo | string | 代理信息 | - | |
└─surveyObject | string | 查询对象 | - | |
└─orderCreateTime | string | 订单创建时间 | - | yyyy-MM-dd HH:mm:ss |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"channel": "",
"mobile": "",
"complaintType": "",
"complaintContent": "",
"complaintImgList": [
""
],
"orderCount": 0,
"currUserOrderCount": 0,
"state": 0,
"effectTime": "yyyy-MM-dd HH:mm:ss",
"processEndTime": "yyyy-MM-dd HH:mm:ss",
"processTime": "yyyy-MM-dd HH:mm:ss",
"isPlatProcess": true,
"complaintAmount": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"refundAmount": 0,
"thirdId": "",
"linkMobile": "",
"auditRemark": "",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"details": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"complaintId": 0,
"orderNo": "",
"payNo": "",
"userId": 0,
"templateCode": "",
"templateName": "",
"thirdTradeNo": "",
"state": 0,
"isPlatProcess": true,
"refundFlag": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"directBrokerage": 0,
"refundAmount": 0,
"processType": "",
"processTime": "yyyy-MM-dd HH:mm:ss",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"surveyType": 0,
"agentInfo": "",
"surveyObject": "",
"orderCreateTime": "yyyy-MM-dd HH:mm:ss"
}
]
},
"timestamp": 0,
"traceId": ""
}1.2.6.处理投诉
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 处理投诉
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
complaintId | int64 | 投诉单id | true | - | 0 |
detailIds | array | 明细id，为空代表处理投诉单下所有订单 | false | - | "0,0" |
processType | string | 处理类型，refund：退款，offline：线下协商撤诉 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/complaint/process' --data '{
"complaintId": 0,
"detailIds": [
0
],
"processType": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.3.订单开放接口
1.3.1.提交检测订单
Type: POST
Author: wangqidong created on 2024/8/16
Content-Type: application/json
Description: 提交检测订单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
surveyType | int32 | 调查类型，10：个人（默认），20：企业，30：车辆 | false | - | 0 |
name | string | 姓名，surveyType=10必传 | false | - | |
idCard | string | 身份证，surveyType=10必传 | false | - | |
mobile | string | 手机号，surveyType=10必传 | false | - | |
plateNumber | string | 车牌号 | false | - | |
vin | string | 车架号 Validation[Pattern(regexp=^[A-HJ-NPR-Z0-9]{8}[X0-9]([A-HJ-NPR-Z0-9]{3}\d{5}|[A-HJ-NPR-Z0-9]{5}\d{3})$, message= vin码输入错误)] | false | - | |
bizImages | string | 业务照片，个人：身份证，企业：营业执照，车辆：行驶证 | false | - | |
templateCode | string | 报告模板编码 | true | - | |
selectedTemplateCodeList | array | 选择的查询项目 | false | - | """,""" |
smsCode | string | 验证码 | false | - | |
spreadUserId | int64 | 推广用户id | false | - | 0 |
payMethod | string | 支付方式 | false | - | |
payerOpenid | string | 支付人openid | false | - | |
captchaToken | string | 人机验证token | false | - | |
confirmRepeat | boolean | 确认重复下单 | false | - | true |
faceRedirectUrl | string | 人脸识别通过重定向地址 | false | - | |
againOrderNo | string | 相同身份再次下单订单号 | false | - | |
accreditType | int32 | 指定授权类型，10：三要素认证，20：人脸识别 | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/open/submit' --data '{
"surveyType": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"bizImages": "",
"templateCode": "",
"selectedTemplateCodeList": [
""
],
"smsCode": "",
"spreadUserId": 0,
"payMethod": "",
"payerOpenid": "",
"captchaToken": "",
"confirmRepeat": true,
"faceRedirectUrl": "",
"againOrderNo": "",
"accreditType": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─payType | string | 业务类型，pay-支付，recharge-账户充值，refund-退款 | - | |
└─payMethod | string | 支付方式 | - | |
└─businessType | string | 业务类型（业务方指定） | - | |
└─businessNo | string | 业务单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─feeName | string | 费用项名称 | - | |
└─amount | number | 需支付金额 | - | 0 |
└─applyPayResult | object | 申请支付结果（传递了支付方式会返回） | - | |
└─isPaid | boolean | 是否已支付 | - | true |
└─logo | string | Logo | - | |
└─payData | object | 支付数据 | - | |
└─logo | string | Logo | - | |
└─expireSeconds | int32 | 剩余可支付时间（秒） | - | 0 |
└─payUrl | string | 支付地址 | - | |
└─payInfo | string | 支付信息 | - | |
└─wechatPayExtra | object | 微信支付额外字段 | - | |
└─appId | string | appid | - | |
└─timeStamp | string | 时间戳 | - | |
└─nonceStr | string | 随机字符串 | - | |
└─package | string | 支付地址 | - | |
└─signType | string | 签名类型，默认为RSA，仅支持RSA。 | - | |
└─paySign | string | 签名 | - | |
└─payAccountId | int64 | No comments found. | - | 0 |
└─walletFlowNo | string | 钱包流水编号，钱包支付会记录 | - | |
└─extraData | object | 额外数据 | - | |
└─giveQuota | number | 赠送金额 | - | 0 |
└─onlyNewGive | boolean | 赠送金额是否新客专享 | - | true |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─discountTitle | string | 优惠标题 | - | |
└─stoken | string | 临时token | - | |
└─liveUrl | string | 人脸识别地址 | - | |
└─orderState | int32 | 订单状态 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"payType": "",
"payMethod": "",
"businessType": "",
"businessNo": "",
"state": 0,
"feeName": "",
"amount": 0,
"applyPayResult": {
"isPaid": true,
"logo": "",
"payData": {
"logo": "",
"expireSeconds": 0,
"payUrl": "",
"payInfo": "",
"wechatPayExtra": {
"appId": "",
"timeStamp": "",
"nonceStr": "",
"package": "",
"signType": "",
"paySign": ""
}
},
"payAccountId": 0,
"walletFlowNo": ""
},
"extraData": {
"giveQuota": 0,
"onlyNewGive": true
},
"orderNo": "",
"payNo": "",
"originAmount": 0,
"orderAmount": 0,
"discountTitle": "",
"stoken": "",
"liveUrl": "",
"orderState": 0
},
"timestamp": 0,
"traceId": ""
}1.3.2.订单列表
Type: POST
Author: wangqidong created on 2024/8/16
Content-Type: application/json
Description: 订单列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
submitType | int32 | 下单方式，10-直查，20-扫码查询 | false | - | 0 |
keyword | string | 搜索关键字 | false | - | |
stateList | array | 订单状态 | false | - | "0,0" |
payStateList | array | 支付状态 | false | - | "0,0" |
name | string | 姓名全匹配 | false | - | |
mobile | string | 手机号 | false | - | |
templateCode | string | 模板编码 | false | - | |
surveyType | int32 | 调查类型，10-个人，20-企业 | false | - | 0 |
payMethod | string | 支付方式 | false | - | |
finishTimeGte | string | 实际完成时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
finishTimeLte | string | 实际完成时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeGte | string | 创建时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 创建时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
queryComplainable | boolean | 是否查询可投诉订单 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/open/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"submitType": 0,
"keyword": "",
"stateList": [
0
],
"payStateList": [
0
],
"name": "",
"mobile": "",
"templateCode": "",
"surveyType": 0,
"payMethod": "",
"finishTimeGte": "yyyy-MM-dd HH:mm:ss",
"finishTimeLte": "yyyy-MM-dd HH:mm:ss",
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss",
"queryComplainable": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─orderNo | string | 订单编号 | - | |
└─userId | int64 | 用户id | - | 0 |
└─userName | string | 用户名 | - | |
└─submitType | int32 | 下单方式，10-直查，20-扫码查询 | - | 0 |
└─state | int32 | 订单状态，10-待支付，50-进行中，,100-已完成 | - | 0 |
└─payState | int32 | 支付状态 | - | 0 |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─plateNumber | string | 车牌号 | - | |
└─vin | string | 车架号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─paidAmount | number | 实付金额 | - | 0 |
└─refundAmount | number | 订单已退款金额 | - | 0 |
└─payMethod | string | 支付方式 | - | |
└─payTime | string | 支付时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 实际完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─refundTime | string | 退款时间 | - | yyyy-MM-dd HH:mm:ss |
└─brokerageAmount | number | 佣金 | - | 0 |
└─disputeType | string | 订单争议类型 | - | |
└─payNo | string | 支付单号 | - | |
└─reportLevel | string | 风险等级 | - | |
└─operatorName | string | 操作员名称 | - | |
└─seqNo | string | 流水号 | - | |
└─reportViewable | boolean | 是否可查看报告 | - | true |
└─appcode | string | appcode | - | |
└─bits | int64 | 位标 | - | 0 |
└─reportUrl | string | 报告地址 | - | |
└─shareCode | string | No comments found. | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"orderNo": "",
"userId": 0,
"userName": "",
"submitType": 0,
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"originAmount": 0,
"orderAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payMethod": "",
"payTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"refundTime": "yyyy-MM-dd HH:mm:ss",
"brokerageAmount": 0,
"disputeType": "",
"payNo": "",
"reportLevel": "",
"operatorName": "",
"seqNo": "",
"reportViewable": true,
"appcode": "",
"bits": 0,
"reportUrl": "",
"shareCode": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.3.3.报告示例
Type: GET
Author: wangqidong created on 2024/8/16
Content-Type: application/x-www-form-urlencoded
Description: 报告示例
Query-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | No comments found. | false | - |
Request-example:
curl -X GET -i '/dex/rs/mini/order/open/queryExampleReport?templateCode='Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─orderNo | string | 订单编号 | - | |
└─isFinished | boolean | 报告是否完成 | - | true |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─createTime | string | 下单时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 报告生成时间 | - | yyyy-MM-dd HH:mm:ss |
└─reportLevel | string | 风险指数 | - | |
└─riskScore | int32 | 风险分 | - | 0 |
└─reportIndexes | array | 报告指标 | - | |
└─code | string | 指标编码 | - | |
└─name | string | 指标名称 | - | |
└─value | string | 指标值 | - | |
└─valueExplain | string | value说明 | - | |
└─valueRangeMin | string | 最小值 | - | |
└─valueRangeMax | string | 最小值 | - | |
└─description | string | 说明 | - | |
└─riskLevel | string | 风险度，low，mid，high | - | |
└─riskColor | string | 颜色 | - | |
└─reportIssues | array | 风险点概览 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─icon | string | 图标 | - | |
└─issues | array | 风险点 | - | """,""" |
└─personalInfo | object | 个人信息 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─gender | string | 性别 | - | |
└─age | int32 | 年龄 | - | 0 |
└─registerResidenceAddress | string | 户籍地 | - | |
└─realNamePass | boolean | 实名认证是否通过 | - | true |
└─constellation | string | 星座 | - | |
└─marriageStatus | string | 婚姻状态 | - | |
└─mobileInfo | object | 手机号信息 | - | |
└─mobile | string | 手机号 | - | |
└─mobileTriplePass | boolean | 手机号身份证姓名一致性校验结果 | - | true |
└─operatorType | string | 运营商类型，1：移动，2：联通，3：电信 | - | |
└─onlineDuration | string | 在网时长，A：[0,3) B：[3,6) C：[6,12) D：[12,24) E：[24-36)，移动为[24,+) F：[36,+)，单位：月，移动不反馈 | - | |
└─onlineStatus | string | 在网状态 | - | |
└─belongLocation | string | 归属地 | - | |
└─suspectedCard | boolean | 是否疑似养卡 | - | true |
└─courtSummary | object | 司法风险概述 | - | |
└─zhixing | boolean | 被执行人：true/false | - | true |
└─xiangao | boolean | 限制高消费 true/false | - | true |
└─shean | boolean | 涉案人员 true/false | - | true |
└─beigao | boolean | 被告人员 true/false | - | true |
└─beigaowei | boolean | 被告未结案人员 true/false | - | true |
└─xingshi | boolean | 是否命中刑事案件 true/false | - | true |
└─beigaoweimoney | string | 被告未结案金额（等级） | - | |
└─beigaoweimoneyDesc | string | 被告未结案金额区间（万元），这个字段直接展示 | - | |
└─loanSummary | object | 借贷风险概述（全景雷达产品返回，其他东西不要往这里面加） | - | |
└─shenqingzhunru | int32 | 申请准入分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─zhixindu | int32 | 置信度评分50-100，[50-60]-红色、(60,80]-橙色、(80,100]-绿色 | - | 0 |
└─xingweifen | int32 | 贷款行为分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─chaxunzongcishu | string | 机构查询总次数 | - | |
└─zhengchangbili | string | 正常还款订单数占贷款总订单数比例 | - | |
└─yijieqingcount | string | 已结清订单数 | - | |
└─shouxinedu | string | 预估网贷授信额度 | - | |
└─jiekuanmoneyzong | string | 借款总金额（2 年内） | - | |
└─jiekuancount | string | 借贷机构数（2 年内） | - | |
└─debtamount | string | 逾期总金额（2 年内） | - | |
└─wangdaicahnpincount | string | 网贷产品数 | - | |
└─reportItems | array | 报告明细 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─notes | string | 说明 | - | |
└─icon | string | 图标 | - | |
└─sv | string | 策略版本号 | - | |
└─reportUrl | string | 子项报告链接 | - | |
└─result | object | 结果 | - | |
└─sort | int32 | 排序 | - | 0 |
└─customData | object | 定制内容 | - | |
└─reportUrl | string | 报告地址 | - | |
└─allowShare | boolean | 报告是否允许分享 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"orderNo": "",
"isFinished": true,
"name": "",
"idCard": "",
"mobile": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"reportLevel": "",
"riskScore": 0,
"reportIndexes": [
{
"code": "",
"name": "",
"value": "",
"valueExplain": "",
"valueRangeMin": "",
"valueRangeMax": "",
"description": "",
"riskLevel": "",
"riskColor": ""
}
],
"reportIssues": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"icon": "",
"issues": [
""
]
}
],
"personalInfo": {
"name": "",
"idCard": "",
"mobile": "",
"gender": "",
"age": 0,
"registerResidenceAddress": "",
"realNamePass": true,
"constellation": "",
"marriageStatus": ""
},
"mobileInfo": {
"mobile": "",
"mobileTriplePass": true,
"operatorType": "",
"onlineDuration": "",
"onlineStatus": "",
"belongLocation": "",
"suspectedCard": true
},
"courtSummary": {
"zhixing": true,
"xiangao": true,
"shean": true,
"beigao": true,
"beigaowei": true,
"xingshi": true,
"beigaoweimoney": "",
"beigaoweimoneyDesc": ""
},
"loanSummary": {
"shenqingzhunru": 0,
"zhixindu": 0,
"xingweifen": 0,
"chaxunzongcishu": "",
"zhengchangbili": "",
"yijieqingcount": "",
"shouxinedu": "",
"jiekuanmoneyzong": "",
"jiekuancount": "",
"debtamount": "",
"wangdaicahnpincount": ""
},
"reportItems": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"notes": "",
"icon": "",
"sv": "",
"reportUrl": "",
"result": {},
"sort": 0
}
],
"customData": {
"object": "any object"
},
"reportUrl": "",
"allowShare": true
},
"timestamp": 0,
"traceId": ""
}1.3.4.企业订单下单
Type: POST
Author: wangqidong created on 2024/8/16
Content-Type: application/json
Description: 企业订单下单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
surveyType | int32 | 调查类型，10：个人（默认），20：企业，30：车辆 | false | - | 0 |
name | string | 姓名，surveyType=10必传 | false | - | |
idCard | string | 身份证，surveyType=10必传 | false | - | |
mobile | string | 手机号，surveyType=10必传 | false | - | |
plateNumber | string | 车牌号 | false | - | |
vin | string | 车架号 Validation[Pattern(regexp=^[A-HJ-NPR-Z0-9]{8}[X0-9]([A-HJ-NPR-Z0-9]{3}\d{5}|[A-HJ-NPR-Z0-9]{5}\d{3})$, message= vin码输入错误)] | false | - | |
bizImages | string | 业务照片，个人：身份证，企业：营业执照，车辆：行驶证 | false | - | |
templateCode | string | 报告模板编码 | false | - | |
selectedTemplateCodeList | array | 选择的查询项目 | false | - | """,""" |
smsCode | string | 验证码 | false | - | |
spreadUserId | int64 | 推广用户id | false | - | 0 |
payMethod | string | 支付方式 | false | - | |
payerOpenid | string | 支付人openid | false | - | |
captchaToken | string | 人机验证token | false | - | |
confirmRepeat | boolean | 确认重复下单 | false | - | true |
faceRedirectUrl | string | 人脸识别通过重定向地址 | false | - | |
againOrderNo | string | 相同身份再次下单订单号 | false | - | |
accreditType | int32 | 指定授权类型，10：三要素认证，20：人脸识别 | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/open/submitEnt' --data '{
"surveyType": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"bizImages": "",
"templateCode": "",
"selectedTemplateCodeList": [
""
],
"smsCode": "",
"spreadUserId": 0,
"payMethod": "",
"payerOpenid": "",
"captchaToken": "",
"confirmRepeat": true,
"faceRedirectUrl": "",
"againOrderNo": "",
"accreditType": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─payType | string | 业务类型，pay-支付，recharge-账户充值，refund-退款 | - | |
└─payMethod | string | 支付方式 | - | |
└─businessType | string | 业务类型（业务方指定） | - | |
└─businessNo | string | 业务单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─feeName | string | 费用项名称 | - | |
└─amount | number | 需支付金额 | - | 0 |
└─applyPayResult | object | 申请支付结果（传递了支付方式会返回） | - | |
└─isPaid | boolean | 是否已支付 | - | true |
└─logo | string | Logo | - | |
└─payData | object | 支付数据 | - | |
└─logo | string | Logo | - | |
└─expireSeconds | int32 | 剩余可支付时间（秒） | - | 0 |
└─payUrl | string | 支付地址 | - | |
└─payInfo | string | 支付信息 | - | |
└─wechatPayExtra | object | 微信支付额外字段 | - | |
└─appId | string | appid | - | |
└─timeStamp | string | 时间戳 | - | |
└─nonceStr | string | 随机字符串 | - | |
└─package | string | 支付地址 | - | |
└─signType | string | 签名类型，默认为RSA，仅支持RSA。 | - | |
└─paySign | string | 签名 | - | |
└─payAccountId | int64 | No comments found. | - | 0 |
└─walletFlowNo | string | 钱包流水编号，钱包支付会记录 | - | |
└─extraData | object | 额外数据 | - | |
└─giveQuota | number | 赠送金额 | - | 0 |
└─onlyNewGive | boolean | 赠送金额是否新客专享 | - | true |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─discountTitle | string | 优惠标题 | - | |
└─stoken | string | 临时token | - | |
└─liveUrl | string | 人脸识别地址 | - | |
└─orderState | int32 | 订单状态 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"payType": "",
"payMethod": "",
"businessType": "",
"businessNo": "",
"state": 0,
"feeName": "",
"amount": 0,
"applyPayResult": {
"isPaid": true,
"logo": "",
"payData": {
"logo": "",
"expireSeconds": 0,
"payUrl": "",
"payInfo": "",
"wechatPayExtra": {
"appId": "",
"timeStamp": "",
"nonceStr": "",
"package": "",
"signType": "",
"paySign": ""
}
},
"payAccountId": 0,
"walletFlowNo": ""
},
"extraData": {
"giveQuota": 0,
"onlyNewGive": true
},
"orderNo": "",
"payNo": "",
"originAmount": 0,
"orderAmount": 0,
"discountTitle": "",
"stoken": "",
"liveUrl": "",
"orderState": 0
},
"timestamp": 0,
"traceId": ""
}1.4.风险检测模板
1.4.1.模板列表
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 模板列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码（详情模板编码和推广码二选一） | false | - | |
spreadCode | string | 推广码（详情模板编码和推广码二选一） | false | - | |
agentId | int64 | 代理id，spreadCode不为空时无效 | false | - | 0 |
subTemplateCodeList | array | 子项模板编码 | false | - | """,""" |
onlyDefaultIfSet | boolean | 如果设置了默认模板，仅返回默认模板 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/queryList' --data '{
"templateCode": "",
"spreadCode": "",
"agentId": 0,
"subTemplateCodeList": [
""
],
"onlyDefaultIfSet": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─editable | boolean | 是否允许编辑 0不允许 1允许 | - | true |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─subTemplates | array | 子模板 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─parentTemplateCode | string | 上级模板编码 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
└─upperRoyalty | number | 上级代理分成 | - | 0 |
└─superRoyalty | number | 总代分成 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─brokerageDetail | object | 佣金信息 | - | |
└─userId | int64 | 用户id | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─brokerage | number | 佣金 | - | 0 |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─sort | int32 | No comments found. | - | 0 |
└─subTemplates | array | No comments found. | - | |
└─sort | int32 | No comments found. | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"editable": true,
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"spreadUserId": 0,
"spreadCode": "",
"subTemplates": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"parentTemplateCode": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"superRoyalty": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"brokerageDetail": {
"userId": 0,
"directUserId": 0,
"brokerage": 0
},
"spreadUserId": 0,
"spreadCode": "",
"sort": 0,
"subTemplates": [
{
"$ref": ".."
}
]
}
],
"sort": 0
}
],
"timestamp": 0,
"traceId": ""
}1.4.2.推广模板列表
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 推广模板列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码（详情模板编码和推广码二选一） | false | - | |
spreadCode | string | 推广码（详情模板编码和推广码二选一） | false | - | |
agentId | int64 | 代理id，spreadCode不为空时无效 | false | - | 0 |
subTemplateCodeList | array | 子项模板编码 | false | - | """,""" |
onlyDefaultIfSet | boolean | 如果设置了默认模板，仅返回默认模板 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/spreadList' --data '{
"templateCode": "",
"spreadCode": "",
"agentId": 0,
"subTemplateCodeList": [
""
],
"onlyDefaultIfSet": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─parentTemplateCode | string | 上级模板编码 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
└─upperRoyalty | number | 上级代理分成 | - | 0 |
└─superRoyalty | number | 总代分成 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─brokerageDetail | object | 佣金信息 | - | |
└─userId | int64 | 用户id | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─brokerage | number | 佣金 | - | 0 |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─sort | int32 | No comments found. | - | 0 |
└─subTemplates | array | No comments found. | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"parentTemplateCode": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"superRoyalty": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"brokerageDetail": {
"userId": 0,
"directUserId": 0,
"brokerage": 0
},
"spreadUserId": 0,
"spreadCode": "",
"sort": 0,
"subTemplates": [
{
"$ref": ".."
}
]
}
],
"timestamp": 0,
"traceId": ""
}1.4.3.销售价可设置区间
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 销售价可设置区间
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/querySalesRange' --data '{
"templateCode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─min | number | 推广价下限 | - | 0 |
└─max | number | 推广价下限 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"min": 0,
"max": 0
},
"timestamp": 0,
"traceId": ""
}1.4.4.生成推广海报
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 生成推广海报
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - | |
spreadCode | string | 推广码 | true | - | |
isSync | boolean | 是否同步生成，默认false | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/queryPosters' --data '{
"templateCode": "",
"spreadCode": "",
"isSync": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─templateCode | string | 模板编码 | - | |
└─spreadCode | string | 推广码 | - | |
└─posterList | array | 海报 | - | """,""" |
└─spreadUrl | string | 推广链接 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"templateCode": "",
"spreadCode": "",
"posterList": [
""
],
"spreadUrl": ""
},
"timestamp": 0,
"traceId": ""
}1.4.5.获取模板推广海报（批量）
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 获取模板推广海报（批量）
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCodeList | array | 模板编号 | true | - | """,""" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/gainPosters' --data '{
"templateCodeList": [
""
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─templateCode | string | 模板编码 | - | |
└─spreadCode | string | 推广码 | - | |
└─posterList | array | 海报 | - | """,""" |
└─spreadUrl | string | 推广链接 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"templateCode": "",
"spreadCode": "",
"posterList": [
""
],
"spreadUrl": ""
}
],
"timestamp": 0,
"traceId": ""
}1.4.6.设置默认模板
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 设置默认模板
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/setDefault' --data '{
"templateCode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.4.7.查询默认模板
Type: GET
Author: wangqidong created on 2024/6/25
Content-Type: application/x-www-form-urlencoded
Description: 查询默认模板
Request-example:
curl -X GET -i '/dex/rs/mini/template/queryDefault'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─parentTemplateCode | string | 上级模板编码 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
└─upperRoyalty | number | 上级代理分成 | - | 0 |
└─superRoyalty | number | 总代分成 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─brokerageDetail | object | 佣金信息 | - | |
└─userId | int64 | 用户id | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─brokerage | number | 佣金 | - | 0 |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─sort | int32 | No comments found. | - | 0 |
└─subTemplates | array | No comments found. | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"parentTemplateCode": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"superRoyalty": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"brokerageDetail": {
"userId": 0,
"directUserId": 0,
"brokerage": 0
},
"spreadUserId": 0,
"spreadCode": "",
"sort": 0,
"subTemplates": [
{
"$ref": ".."
}
]
},
"timestamp": 0,
"traceId": ""
}1.4.8.模板详情
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 模板详情
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码（详情模板编码和推广码二选一） | false | - | |
spreadCode | string | 推广码（详情模板编码和推广码二选一） | false | - | |
agentId | int64 | 代理id，spreadCode不为空时无效 | false | - | 0 |
subTemplateCodeList | array | 子项模板编码 | false | - | """,""" |
onlyDefaultIfSet | boolean | 如果设置了默认模板，仅返回默认模板 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/queryDetail' --data '{
"templateCode": "",
"spreadCode": "",
"agentId": 0,
"subTemplateCodeList": [
""
],
"onlyDefaultIfSet": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─parentTemplateCode | string | 上级模板编码 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
└─upperRoyalty | number | 上级代理分成 | - | 0 |
└─superRoyalty | number | 总代分成 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─brokerageDetail | object | 佣金信息 | - | |
└─userId | int64 | 用户id | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─brokerage | number | 佣金 | - | 0 |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─sort | int32 | No comments found. | - | 0 |
└─subTemplates | array | No comments found. | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"parentTemplateCode": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"superRoyalty": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"brokerageDetail": {
"userId": 0,
"directUserId": 0,
"brokerage": 0
},
"spreadUserId": 0,
"spreadCode": "",
"sort": 0,
"subTemplates": [
{
"$ref": ".."
}
]
},
"timestamp": 0,
"traceId": ""
}1.4.9.计算价格
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 计算价格
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码（详情模板编码和推广码二选一） | false | - | |
spreadCode | string | 推广码（详情模板编码和推广码二选一） | false | - | |
agentId | int64 | 代理id，spreadCode不为空时无效 | false | - | 0 |
subTemplateCodeList | array | 子项模板编码 | false | - | """,""" |
onlyDefaultIfSet | boolean | 如果设置了默认模板，仅返回默认模板 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/calculatePrice' --data '{
"templateCode": "",
"spreadCode": "",
"agentId": 0,
"subTemplateCodeList": [
""
],
"onlyDefaultIfSet": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 现价 | - | 0 |
└─discountTitle | string | 折扣标题 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"originPrice": 0,
"price": 0,
"discountTitle": ""
},
"timestamp": 0,
"traceId": ""
}1.4.10.设置客户价格
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 设置客户价格
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - | |
salesPrice | number | 客户价 | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/template/setSalesPrice' --data '{
"templateCode": "",
"salesPrice": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.4.11.模板内容展示
Type: GET
Author: wangqidong created on 2024/6/25
Content-Type: application/x-www-form-urlencoded
Description: 模板内容展示
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | No comments found. | true | - |
Request-example:
curl -X GET -i '/dex/rs/mini/template/displayItems/{templateCode}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─showName | string | 名称 | - | |
└─itemIcon | string | 图标 | - | |
└─backColor | string | 背景色 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"showName": "",
"itemIcon": "",
"backColor": ""
}
],
"timestamp": 0,
"traceId": ""
}1.5.平台相关接口
1.5.1.查询平台配置
Type: GET
Author: wangqidong created on 2024/9/21
Content-Type: application/x-www-form-urlencoded
Description: 查询平台配置
Request-example:
curl -X GET -i '/dex/rs/mini/platform/queryConfig'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─appcode | string | 应用编码 | - | |
└─platName | string | 平台名称 | - | |
└─platUserId | int64 | 平台用户id | - | 0 |
└─logo | string | 平台logo | - | |
└─toneUpLocked | boolean | 增益金额是否允许修改 | - | true |
└─toneUpAmount | number | 增益金额 | - | 0 |
└─toneUpRangeFloor | number | 增益金额修改下限 | - | 0 |
└─toneUpRangeCeiling | number | 增益金额修改上限 | - | 0 |
└─reportValidDays | int32 | 报告有效天数 | - | 0 |
└─bits | int64 | 开关配置 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"appcode": "",
"platName": "",
"platUserId": 0,
"logo": "",
"toneUpLocked": true,
"toneUpAmount": 0,
"toneUpRangeFloor": 0,
"toneUpRangeCeiling": 0,
"reportValidDays": 0,
"bits": 0
},
"timestamp": 0,
"traceId": ""
}1.5.2.查询文章
Type: POST
Author: wangqidong created on 2024/9/21
Content-Type: application/json
Description: 查询文章
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/platform/essayList' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─title | string | 标题 | - | |
└─mainImg | string | 主图 | - | |
└─url | string | 文章链接 | - | |
└─isHidden | boolean | 是否隐藏 | - | true |
└─appcode | string | 可见应用编码 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"title": "",
"mainImg": "",
"url": "",
"isHidden": true,
"appcode": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.5.3.查询开关配置
Type: GET
Author: wangqidong created on 2024/9/21
Content-Type: application/x-www-form-urlencoded
Description: 查询开关配置
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
index | int32 | No comments found. | true | - | 0 |
Request-example:
curl -X GET -i '/dex/rs/mini/platform/querySwitchConfig/{index}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | boolean | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": true,
"timestamp": 0,
"traceId": ""
}1.6.风险检测订单
1.6.1.下单前置协议预览
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 下单前置协议预览
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
surveyType | int32 | 调查类型，10：个人（默认），20：企业，30：车辆 | false | - | 0 |
name | string | 姓名，surveyType=10必传 | false | - | |
idCard | string | 身份证，surveyType=10必传 | false | - | |
mobile | string | 手机号，surveyType=10必传 | false | - | |
plateNumber | string | 车牌号 | false | - | |
vin | string | 车架号 Validation[Pattern(regexp=^[A-HJ-NPR-Z0-9]{8}[X0-9]([A-HJ-NPR-Z0-9]{3}\d{5}|[A-HJ-NPR-Z0-9]{5}\d{3})$, message= vin码输入错误)] | false | - | |
bizImages | string | 业务照片，个人：身份证，企业：营业执照，车辆：行驶证 | false | - | |
templateCode | string | 报告模板编码 | true | - | |
selectedTemplateCodeList | array | 选择的查询项目 | false | - | """,""" |
smsCode | string | 验证码 | false | - | |
spreadUserId | int64 | 推广用户id | false | - | 0 |
payMethod | string | 支付方式 | false | - | |
payerOpenid | string | 支付人openid | false | - | |
captchaToken | string | 人机验证token | false | - | |
confirmRepeat | boolean | 确认重复下单 | false | - | true |
faceRedirectUrl | string | 人脸识别通过重定向地址 | false | - | |
againOrderNo | string | 相同身份再次下单订单号 | false | - | |
accreditType | int32 | 指定授权类型，10：三要素认证，20：人脸识别 | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/submitPreviewProtocols' --data '{
"surveyType": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"bizImages": "",
"templateCode": "",
"selectedTemplateCodeList": [
""
],
"smsCode": "",
"spreadUserId": 0,
"payMethod": "",
"payerOpenid": "",
"captchaToken": "",
"confirmRepeat": true,
"faceRedirectUrl": "",
"againOrderNo": "",
"accreditType": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─templateCode | string | 协议模板编码 | - | |
└─name | string | 协议名称 | - | |
└─templateUrl | string | 模板链接 | - | |
└─htmlBody | string | 协议内容（html） | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"templateCode": "",
"name": "",
"templateUrl": "",
"htmlBody": ""
}
],
"timestamp": 0,
"traceId": ""
}1.6.2.提交检测订单
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 提交检测订单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
surveyType | int32 | 调查类型，10：个人（默认），20：企业，30：车辆 | false | - | 0 |
name | string | 姓名，surveyType=10必传 | false | - | |
idCard | string | 身份证，surveyType=10必传 | false | - | |
mobile | string | 手机号，surveyType=10必传 | false | - | |
plateNumber | string | 车牌号 | false | - | |
vin | string | 车架号 Validation[Pattern(regexp=^[A-HJ-NPR-Z0-9]{8}[X0-9]([A-HJ-NPR-Z0-9]{3}\d{5}|[A-HJ-NPR-Z0-9]{5}\d{3})$, message= vin码输入错误)] | false | - | |
bizImages | string | 业务照片，个人：身份证，企业：营业执照，车辆：行驶证 | false | - | |
templateCode | string | 报告模板编码 | true | - | |
selectedTemplateCodeList | array | 选择的查询项目 | false | - | """,""" |
smsCode | string | 验证码 | false | - | |
spreadUserId | int64 | 推广用户id | false | - | 0 |
payMethod | string | 支付方式 | false | - | |
payerOpenid | string | 支付人openid | false | - | |
captchaToken | string | 人机验证token | false | - | |
confirmRepeat | boolean | 确认重复下单 | false | - | true |
faceRedirectUrl | string | 人脸识别通过重定向地址 | false | - | |
againOrderNo | string | 相同身份再次下单订单号 | false | - | |
accreditType | int32 | 指定授权类型，10：三要素认证，20：人脸识别 | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/submit' --data '{
"surveyType": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"bizImages": "",
"templateCode": "",
"selectedTemplateCodeList": [
""
],
"smsCode": "",
"spreadUserId": 0,
"payMethod": "",
"payerOpenid": "",
"captchaToken": "",
"confirmRepeat": true,
"faceRedirectUrl": "",
"againOrderNo": "",
"accreditType": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─payType | string | 业务类型，pay-支付，recharge-账户充值，refund-退款 | - | |
└─payMethod | string | 支付方式 | - | |
└─businessType | string | 业务类型（业务方指定） | - | |
└─businessNo | string | 业务单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─feeName | string | 费用项名称 | - | |
└─amount | number | 需支付金额 | - | 0 |
└─applyPayResult | object | 申请支付结果（传递了支付方式会返回） | - | |
└─isPaid | boolean | 是否已支付 | - | true |
└─logo | string | Logo | - | |
└─payData | object | 支付数据 | - | |
└─logo | string | Logo | - | |
└─expireSeconds | int32 | 剩余可支付时间（秒） | - | 0 |
└─payUrl | string | 支付地址 | - | |
└─payInfo | string | 支付信息 | - | |
└─wechatPayExtra | object | 微信支付额外字段 | - | |
└─appId | string | appid | - | |
└─timeStamp | string | 时间戳 | - | |
└─nonceStr | string | 随机字符串 | - | |
└─package | string | 支付地址 | - | |
└─signType | string | 签名类型，默认为RSA，仅支持RSA。 | - | |
└─paySign | string | 签名 | - | |
└─payAccountId | int64 | No comments found. | - | 0 |
└─walletFlowNo | string | 钱包流水编号，钱包支付会记录 | - | |
└─extraData | object | 额外数据 | - | |
└─giveQuota | number | 赠送金额 | - | 0 |
└─onlyNewGive | boolean | 赠送金额是否新客专享 | - | true |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─discountTitle | string | 优惠标题 | - | |
└─stoken | string | 临时token | - | |
└─liveUrl | string | 人脸识别地址 | - | |
└─orderState | int32 | 订单状态 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"payType": "",
"payMethod": "",
"businessType": "",
"businessNo": "",
"state": 0,
"feeName": "",
"amount": 0,
"applyPayResult": {
"isPaid": true,
"logo": "",
"payData": {
"logo": "",
"expireSeconds": 0,
"payUrl": "",
"payInfo": "",
"wechatPayExtra": {
"appId": "",
"timeStamp": "",
"nonceStr": "",
"package": "",
"signType": "",
"paySign": ""
}
},
"payAccountId": 0,
"walletFlowNo": ""
},
"extraData": {
"giveQuota": 0,
"onlyNewGive": true
},
"orderNo": "",
"payNo": "",
"originAmount": 0,
"orderAmount": 0,
"discountTitle": "",
"stoken": "",
"liveUrl": "",
"orderState": 0
},
"timestamp": 0,
"traceId": ""
}1.6.3.订单列表
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 订单列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
submitType | int32 | 下单方式，10-直查，20-扫码查询 | false | - | 0 |
keyword | string | 搜索关键字 | false | - | |
stateList | array | 订单状态 | false | - | "0,0" |
payStateList | array | 支付状态 | false | - | "0,0" |
name | string | 姓名全匹配 | false | - | |
mobile | string | 手机号 | false | - | |
templateCode | string | 模板编码 | false | - | |
surveyType | int32 | 调查类型，10-个人，20-企业 | false | - | 0 |
payMethod | string | 支付方式 | false | - | |
finishTimeGte | string | 实际完成时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
finishTimeLte | string | 实际完成时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeGte | string | 创建时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 创建时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
queryComplainable | boolean | 是否查询可投诉订单 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"submitType": 0,
"keyword": "",
"stateList": [
0
],
"payStateList": [
0
],
"name": "",
"mobile": "",
"templateCode": "",
"surveyType": 0,
"payMethod": "",
"finishTimeGte": "yyyy-MM-dd HH:mm:ss",
"finishTimeLte": "yyyy-MM-dd HH:mm:ss",
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss",
"queryComplainable": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─orderNo | string | 订单编号 | - | |
└─userId | int64 | 用户id | - | 0 |
└─userName | string | 用户名 | - | |
└─submitType | int32 | 下单方式，10-直查，20-扫码查询 | - | 0 |
└─state | int32 | 订单状态，10-待支付，50-进行中，,100-已完成 | - | 0 |
└─payState | int32 | 支付状态 | - | 0 |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─plateNumber | string | 车牌号 | - | |
└─vin | string | 车架号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─paidAmount | number | 实付金额 | - | 0 |
└─refundAmount | number | 订单已退款金额 | - | 0 |
└─payMethod | string | 支付方式 | - | |
└─payTime | string | 支付时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 实际完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─refundTime | string | 退款时间 | - | yyyy-MM-dd HH:mm:ss |
└─brokerageAmount | number | 佣金 | - | 0 |
└─disputeType | string | 订单争议类型 | - | |
└─payNo | string | 支付单号 | - | |
└─reportLevel | string | 风险等级 | - | |
└─operatorName | string | 操作员名称 | - | |
└─seqNo | string | 流水号 | - | |
└─reportViewable | boolean | 是否可查看报告 | - | true |
└─appcode | string | appcode | - | |
└─bits | int64 | 位标 | - | 0 |
└─reportUrl | string | 报告地址 | - | |
└─shareCode | string | No comments found. | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"orderNo": "",
"userId": 0,
"userName": "",
"submitType": 0,
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"originAmount": 0,
"orderAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payMethod": "",
"payTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"refundTime": "yyyy-MM-dd HH:mm:ss",
"brokerageAmount": 0,
"disputeType": "",
"payNo": "",
"reportLevel": "",
"operatorName": "",
"seqNo": "",
"reportViewable": true,
"appcode": "",
"bits": 0,
"reportUrl": "",
"shareCode": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.6.4.查询订单信息
Type: GET
Author: wangqidong created on 2024/6/28
Content-Type: application/x-www-form-urlencoded
Description: 查询订单信息
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | No comments found. | true | - |
Query-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
afterPay | boolean | 是否支付后场景 | true | - | false |
Request-example:
curl -X GET -i '/dex/rs/mini/order/orderInfo/{orderNo}?afterPay=false'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─orderNo | string | 订单编号 | - | |
└─userId | int64 | 用户id | - | 0 |
└─userName | string | 用户名 | - | |
└─submitType | int32 | 下单方式，10-直查，20-扫码查询 | - | 0 |
└─state | int32 | 订单状态，10-待支付，50-进行中，,100-已完成 | - | 0 |
└─payState | int32 | 支付状态 | - | 0 |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─plateNumber | string | 车牌号 | - | |
└─vin | string | 车架号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─paidAmount | number | 实付金额 | - | 0 |
└─refundAmount | number | 订单已退款金额 | - | 0 |
└─payMethod | string | 支付方式 | - | |
└─payTime | string | 支付时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 实际完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─refundTime | string | 退款时间 | - | yyyy-MM-dd HH:mm:ss |
└─brokerageAmount | number | 佣金 | - | 0 |
└─disputeType | string | 订单争议类型 | - | |
└─payNo | string | 支付单号 | - | |
└─reportLevel | string | 风险等级 | - | |
└─operatorName | string | 操作员名称 | - | |
└─seqNo | string | 流水号 | - | |
└─reportViewable | boolean | 是否可查看报告 | - | true |
└─appcode | string | appcode | - | |
└─bits | int64 | 位标 | - | 0 |
└─reportUrl | string | 报告地址 | - | |
└─shareCode | string | No comments found. | - | |
└─surveyObject | string | No comments found. | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"orderNo": "",
"userId": 0,
"userName": "",
"submitType": 0,
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"originAmount": 0,
"orderAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payMethod": "",
"payTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"refundTime": "yyyy-MM-dd HH:mm:ss",
"brokerageAmount": 0,
"disputeType": "",
"payNo": "",
"reportLevel": "",
"operatorName": "",
"seqNo": "",
"reportViewable": true,
"appcode": "",
"bits": 0,
"reportUrl": "",
"shareCode": "",
"surveyObject": ""
},
"timestamp": 0,
"traceId": ""
}1.6.5.取消订单
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 取消订单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/cancel' --data '{
"orderNo": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.6.6.查询报告
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 查询报告
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | false | - | |
shareCode | string | 分享码 | false | - | |
nearTraceId | string | 查询最近报告（下单返回的tradeId） | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/queryReport' --data '{
"orderNo": "",
"shareCode": "",
"nearTraceId": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─orderNo | string | 订单编号 | - | |
└─isFinished | boolean | 报告是否完成 | - | true |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─createTime | string | 下单时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 报告生成时间 | - | yyyy-MM-dd HH:mm:ss |
└─reportLevel | string | 风险指数 | - | |
└─riskScore | int32 | 风险分 | - | 0 |
└─reportIndexes | array | 报告指标 | - | |
└─code | string | 指标编码 | - | |
└─name | string | 指标名称 | - | |
└─value | string | 指标值 | - | |
└─valueExplain | string | value说明 | - | |
└─valueRangeMin | string | 最小值 | - | |
└─valueRangeMax | string | 最小值 | - | |
└─description | string | 说明 | - | |
└─riskLevel | string | 风险度，low，mid，high | - | |
└─riskColor | string | 颜色 | - | |
└─reportIssues | array | 风险点概览 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─icon | string | 图标 | - | |
└─issues | array | 风险点 | - | """,""" |
└─personalInfo | object | 个人信息 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─gender | string | 性别 | - | |
└─age | int32 | 年龄 | - | 0 |
└─registerResidenceAddress | string | 户籍地 | - | |
└─realNamePass | boolean | 实名认证是否通过 | - | true |
└─constellation | string | 星座 | - | |
└─marriageStatus | string | 婚姻状态 | - | |
└─mobileInfo | object | 手机号信息 | - | |
└─mobile | string | 手机号 | - | |
└─mobileTriplePass | boolean | 手机号身份证姓名一致性校验结果 | - | true |
└─operatorType | string | 运营商类型，1：移动，2：联通，3：电信 | - | |
└─onlineDuration | string | 在网时长，A：[0,3) B：[3,6) C：[6,12) D：[12,24) E：[24-36)，移动为[24,+) F：[36,+)，单位：月，移动不反馈 | - | |
└─onlineStatus | string | 在网状态 | - | |
└─belongLocation | string | 归属地 | - | |
└─suspectedCard | boolean | 是否疑似养卡 | - | true |
└─courtSummary | object | 司法风险概述 | - | |
└─zhixing | boolean | 被执行人：true/false | - | true |
└─xiangao | boolean | 限制高消费 true/false | - | true |
└─shean | boolean | 涉案人员 true/false | - | true |
└─beigao | boolean | 被告人员 true/false | - | true |
└─beigaowei | boolean | 被告未结案人员 true/false | - | true |
└─xingshi | boolean | 是否命中刑事案件 true/false | - | true |
└─beigaoweimoney | string | 被告未结案金额（等级） | - | |
└─beigaoweimoneyDesc | string | 被告未结案金额区间（万元），这个字段直接展示 | - | |
└─loanSummary | object | 借贷风险概述（全景雷达产品返回，其他东西不要往这里面加） | - | |
└─shenqingzhunru | int32 | 申请准入分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─zhixindu | int32 | 置信度评分50-100，[50-60]-红色、(60,80]-橙色、(80,100]-绿色 | - | 0 |
└─xingweifen | int32 | 贷款行为分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─chaxunzongcishu | string | 机构查询总次数 | - | |
└─zhengchangbili | string | 正常还款订单数占贷款总订单数比例 | - | |
└─yijieqingcount | string | 已结清订单数 | - | |
└─shouxinedu | string | 预估网贷授信额度 | - | |
└─jiekuanmoneyzong | string | 借款总金额（2 年内） | - | |
└─jiekuancount | string | 借贷机构数（2 年内） | - | |
└─debtamount | string | 逾期总金额（2 年内） | - | |
└─wangdaicahnpincount | string | 网贷产品数 | - | |
└─reportItems | array | 报告明细 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─notes | string | 说明 | - | |
└─icon | string | 图标 | - | |
└─sv | string | 策略版本号 | - | |
└─reportUrl | string | 子项报告链接 | - | |
└─result | object | 结果 | - | |
└─sort | int32 | 排序 | - | 0 |
└─customData | object | 定制内容 | - | |
└─reportUrl | string | 报告地址 | - | |
└─allowShare | boolean | 报告是否允许分享 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"orderNo": "",
"isFinished": true,
"name": "",
"idCard": "",
"mobile": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"reportLevel": "",
"riskScore": 0,
"reportIndexes": [
{
"code": "",
"name": "",
"value": "",
"valueExplain": "",
"valueRangeMin": "",
"valueRangeMax": "",
"description": "",
"riskLevel": "",
"riskColor": ""
}
],
"reportIssues": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"icon": "",
"issues": [
""
]
}
],
"personalInfo": {
"name": "",
"idCard": "",
"mobile": "",
"gender": "",
"age": 0,
"registerResidenceAddress": "",
"realNamePass": true,
"constellation": "",
"marriageStatus": ""
},
"mobileInfo": {
"mobile": "",
"mobileTriplePass": true,
"operatorType": "",
"onlineDuration": "",
"onlineStatus": "",
"belongLocation": "",
"suspectedCard": true
},
"courtSummary": {
"zhixing": true,
"xiangao": true,
"shean": true,
"beigao": true,
"beigaowei": true,
"xingshi": true,
"beigaoweimoney": "",
"beigaoweimoneyDesc": ""
},
"loanSummary": {
"shenqingzhunru": 0,
"zhixindu": 0,
"xingweifen": 0,
"chaxunzongcishu": "",
"zhengchangbili": "",
"yijieqingcount": "",
"shouxinedu": "",
"jiekuanmoneyzong": "",
"jiekuancount": "",
"debtamount": "",
"wangdaicahnpincount": ""
},
"reportItems": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"notes": "",
"icon": "",
"sv": "",
"reportUrl": "",
"result": {},
"sort": 0
}
],
"customData": {
"object": "any object"
},
"reportUrl": "",
"allowShare": true
},
"timestamp": 0,
"traceId": ""
}1.6.7.查询企业报告
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 查询企业报告
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | false | - | |
shareCode | string | 分享码 | false | - | |
nearTraceId | string | 查询最近报告（下单返回的tradeId） | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/queryEntReport' --data '{
"orderNo": "",
"shareCode": "",
"nearTraceId": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─orderNo | string | 订单编号 | - | |
└─isFinished | boolean | 报告是否完成 | - | true |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─createTime | string | 下单时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 报告生成时间 | - | yyyy-MM-dd HH:mm:ss |
└─reportLevel | string | 风险指数 | - | |
└─riskScore | int32 | 风险分 | - | 0 |
└─reportIndexes | array | 报告指标 | - | |
└─code | string | 指标编码 | - | |
└─name | string | 指标名称 | - | |
└─value | string | 指标值 | - | |
└─valueExplain | string | value说明 | - | |
└─valueRangeMin | string | 最小值 | - | |
└─valueRangeMax | string | 最小值 | - | |
└─description | string | 说明 | - | |
└─riskLevel | string | 风险度，low，mid，high | - | |
└─riskColor | string | 颜色 | - | |
└─reportIssues | array | 风险点概览 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─icon | string | 图标 | - | |
└─issues | array | 风险点 | - | """,""" |
└─personalInfo | object | 个人信息 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─gender | string | 性别 | - | |
└─age | int32 | 年龄 | - | 0 |
└─registerResidenceAddress | string | 户籍地 | - | |
└─realNamePass | boolean | 实名认证是否通过 | - | true |
└─constellation | string | 星座 | - | |
└─marriageStatus | string | 婚姻状态 | - | |
└─mobileInfo | object | 手机号信息 | - | |
└─mobile | string | 手机号 | - | |
└─mobileTriplePass | boolean | 手机号身份证姓名一致性校验结果 | - | true |
└─operatorType | string | 运营商类型，1：移动，2：联通，3：电信 | - | |
└─onlineDuration | string | 在网时长，A：[0,3) B：[3,6) C：[6,12) D：[12,24) E：[24-36)，移动为[24,+) F：[36,+)，单位：月，移动不反馈 | - | |
└─onlineStatus | string | 在网状态 | - | |
└─belongLocation | string | 归属地 | - | |
└─suspectedCard | boolean | 是否疑似养卡 | - | true |
└─courtSummary | object | 司法风险概述 | - | |
└─zhixing | boolean | 被执行人：true/false | - | true |
└─xiangao | boolean | 限制高消费 true/false | - | true |
└─shean | boolean | 涉案人员 true/false | - | true |
└─beigao | boolean | 被告人员 true/false | - | true |
└─beigaowei | boolean | 被告未结案人员 true/false | - | true |
└─xingshi | boolean | 是否命中刑事案件 true/false | - | true |
└─beigaoweimoney | string | 被告未结案金额（等级） | - | |
└─beigaoweimoneyDesc | string | 被告未结案金额区间（万元），这个字段直接展示 | - | |
└─loanSummary | object | 借贷风险概述（全景雷达产品返回，其他东西不要往这里面加） | - | |
└─shenqingzhunru | int32 | 申请准入分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─zhixindu | int32 | 置信度评分50-100，[50-60]-红色、(60,80]-橙色、(80,100]-绿色 | - | 0 |
└─xingweifen | int32 | 贷款行为分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─chaxunzongcishu | string | 机构查询总次数 | - | |
└─zhengchangbili | string | 正常还款订单数占贷款总订单数比例 | - | |
└─yijieqingcount | string | 已结清订单数 | - | |
└─shouxinedu | string | 预估网贷授信额度 | - | |
└─jiekuanmoneyzong | string | 借款总金额（2 年内） | - | |
└─jiekuancount | string | 借贷机构数（2 年内） | - | |
└─debtamount | string | 逾期总金额（2 年内） | - | |
└─wangdaicahnpincount | string | 网贷产品数 | - | |
└─reportItems | array | 报告明细 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─notes | string | 说明 | - | |
└─icon | string | 图标 | - | |
└─sv | string | 策略版本号 | - | |
└─reportUrl | string | 子项报告链接 | - | |
└─result | object | 结果 | - | |
└─sort | int32 | 排序 | - | 0 |
└─customData | object | 定制内容 | - | |
└─reportUrl | string | 报告地址 | - | |
└─allowShare | boolean | 报告是否允许分享 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"orderNo": "",
"isFinished": true,
"name": "",
"idCard": "",
"mobile": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"reportLevel": "",
"riskScore": 0,
"reportIndexes": [
{
"code": "",
"name": "",
"value": "",
"valueExplain": "",
"valueRangeMin": "",
"valueRangeMax": "",
"description": "",
"riskLevel": "",
"riskColor": ""
}
],
"reportIssues": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"icon": "",
"issues": [
""
]
}
],
"personalInfo": {
"name": "",
"idCard": "",
"mobile": "",
"gender": "",
"age": 0,
"registerResidenceAddress": "",
"realNamePass": true,
"constellation": "",
"marriageStatus": ""
},
"mobileInfo": {
"mobile": "",
"mobileTriplePass": true,
"operatorType": "",
"onlineDuration": "",
"onlineStatus": "",
"belongLocation": "",
"suspectedCard": true
},
"courtSummary": {
"zhixing": true,
"xiangao": true,
"shean": true,
"beigao": true,
"beigaowei": true,
"xingshi": true,
"beigaoweimoney": "",
"beigaoweimoneyDesc": ""
},
"loanSummary": {
"shenqingzhunru": 0,
"zhixindu": 0,
"xingweifen": 0,
"chaxunzongcishu": "",
"zhengchangbili": "",
"yijieqingcount": "",
"shouxinedu": "",
"jiekuanmoneyzong": "",
"jiekuancount": "",
"debtamount": "",
"wangdaicahnpincount": ""
},
"reportItems": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"notes": "",
"icon": "",
"sv": "",
"reportUrl": "",
"result": {},
"sort": 0
}
],
"customData": {
"object": "any object"
},
"reportUrl": "",
"allowShare": true
},
"timestamp": 0,
"traceId": ""
}1.6.8.分享报告
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 分享报告
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | false | - | |
shareCode | string | 分享码 | false | - | |
nearTraceId | string | 查询最近报告（下单返回的tradeId） | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/shareReport' --data '{
"orderNo": "",
"shareCode": "",
"nearTraceId": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─shareCode | string | 分享码 | - | |
└─shareUrl | string | 分享地址 | - | |
└─validDays | int32 | 有效天数 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"shareCode": "",
"shareUrl": "",
"validDays": 0
},
"timestamp": 0,
"traceId": ""
}1.6.9.我的销售统计
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 我的销售统计
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
queryRange | string | 查询范围 ALL：全部 TD：今天 YD：昨天 CW：本周 LW：上周 CM：本月 LM：上月 CY：本年 LY：去年 N3D：近3天 N7D：近7天 N1H：1小时内 N3H：3小时内 N6H：6小时内 N12H：12小时内 N1W：近1周 N2W：近2周 N3W：近3周 N1M：近1月 N2M：近2月 N3M：近3月 N1Y：近1年 | false | - | |
startDate | string | 开始日期，指定了queryRange该字段无效 | false | - | yyyy-MM-dd |
endDate | string | 开始日期，指定了queryRange该字段无效 | false | - | yyyy-MM-dd |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/mineStatistics' --data '{
"queryRange": "",
"startDate": "yyyy-MM-dd",
"endDate": "yyyy-MM-dd"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─userId | int64 | 用户id | - | 0 |
└─statisticsDate | string | 统计日期 | - | |
└─orderCount | int32 | 已支付订单数量 | - | 0 |
└─orderAmount | number | 已支付订单金额 | - | 0 |
└─refundCount | int32 | 退款订单数量 | - | 0 |
└─refundAmount | number | 退款订单金额 | - | 0 |
└─brokerageAmount | number | 推广收益（包含下级收益） | - | 0 |
└─deductBrokerage | number | 退款扣除收益 | - | 0 |
└─directBrokerage | number | 直销推广收益 | - | 0 |
└─toneUpBrokerage | number | 下级代理收益 | - | 0 |
└─complaintCount | int32 | 投诉笔数 | - | 0 |
└─agentCount | int32 | 代理数量 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"userId": 0,
"statisticsDate": "",
"orderCount": 0,
"orderAmount": 0,
"refundCount": 0,
"refundAmount": 0,
"brokerageAmount": 0,
"deductBrokerage": 0,
"directBrokerage": 0,
"toneUpBrokerage": 0,
"complaintCount": 0,
"agentCount": 0
}
],
"timestamp": 0,
"traceId": ""
}1.6.10.争议订单列表
Type: POST
Author: wangqidong created on 2024/6/28
Content-Type: application/json
Description: 争议订单列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
keyword | string | 搜索关键字 | false | - | |
disputeType | string | 订单争议类型 | false | - | |
refundTimeGte | string | 创建时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
refundTimeLte | string | 创建时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/order/disputeList' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"keyword": "",
"disputeType": "",
"refundTimeGte": "yyyy-MM-dd HH:mm:ss",
"refundTimeLte": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─orderNo | string | 订单编号 | - | |
└─userId | int64 | 用户id | - | 0 |
└─userName | string | 用户名 | - | |
└─state | int32 | 订单状态，10-待支付，50-进行中，,100-已完成 | - | 0 |
└─payState | int32 | 支付状态 | - | 0 |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─plateNumber | string | 车牌号 | - | |
└─vin | string | 车架号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─paidAmount | number | 实付金额 | - | 0 |
└─refundAmount | number | 订单已退款金额 | - | 0 |
└─payMethod | string | 支付方式 | - | |
└─payTime | string | 支付时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 实际完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─refundTime | string | 退款时间 | - | yyyy-MM-dd HH:mm:ss |
└─brokerageAmount | number | 佣金 | - | 0 |
└─brokerageState | int32 | 我的佣金状态，-5：已扣除，其他：未扣除 | - | 0 |
└─disputeType | string | 订单争议类型 | - | |
└─payNo | string | 支付单号 | - | |
└─seqNo | string | 流水号 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"orderNo": "",
"userId": 0,
"userName": "",
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"originAmount": 0,
"orderAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payMethod": "",
"payTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"refundTime": "yyyy-MM-dd HH:mm:ss",
"brokerageAmount": 0,
"brokerageState": 0,
"disputeType": "",
"payNo": "",
"seqNo": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}1.6.11.推广看板
Type: GET
Author: wangqidong created on 2024/6/28
Content-Type: application/x-www-form-urlencoded
Description: 推广看板
Request-example:
curl -X GET -i '/dex/rs/mini/order/spreadBoard'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─todayTotal | int32 | 今日已成交 | - | 0 |
└─orderList | array | 已成交报告列表 | - | |
└─mobile | string | 手机号 | - | |
└─time | string | 时间 | - | |
└─brokerage | number | 收益 | - | 0 |
└─rankingList | array | 代理排行 | - | |
└─userId | int64 | 用户id | - | 0 |
└─serialNo | string | 排名 | - | |
└─name | string | 姓名 | - | |
└─orderCount | int32 | 报告份数 | - | 0 |
└─mineRanking | object | 我的排名 | - | |
└─userId | int64 | 用户id | - | 0 |
└─serialNo | string | 排名 | - | |
└─name | string | 姓名 | - | |
└─orderCount | int32 | 报告份数 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"todayTotal": 0,
"orderList": [
{
"mobile": "",
"time": "",
"brokerage": 0
}
],
"rankingList": [
{
"userId": 0,
"serialNo": "",
"name": "",
"orderCount": 0
}
],
"mineRanking": {
"userId": 0,
"serialNo": "",
"name": "",
"orderCount": 0
}
},
"timestamp": 0,
"traceId": ""
}1.6.12.订单统计
Type: GET
Author: wangqidong created on 2024/6/28
Content-Type: application/x-www-form-urlencoded
Description: 订单统计
Request-example:
curl -X GET -i '/dex/rs/mini/order/mineSurveyStatistics'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─userId | int64 | 用户id | - | 0 |
└─orderCount | int32 | 已支付订单数量 | - | 0 |
└─orderAmount | number | 已支付订单金额 | - | 0 |
└─refundCount | int32 | 退款订单数量 | - | 0 |
└─refundAmount | number | 退款订单金额 | - | 0 |
└─brokerageCount | int32 | 推广收益份数(包括下级代理分佣) | - | 0 |
└─brokerageAmount | number | 推广收益(包括下级代理分佣) | - | 0 |
└─deductCount | int32 | 扣除收益份数 | - | 0 |
└─deductBrokerage | number | 已扣除佣金 | - | 0 |
└─toneUpCount | int32 | 下级代理分佣份数 | - | 0 |
└─toneUpBrokerage | number | 下级代理分佣 | - | 0 |
└─complaintCount | int32 | 投诉笔数 | - | 0 |
└─agentCount | int32 | 代理数量 | - | 0 |
└─appcode | string | 应用编码 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"userId": 0,
"orderCount": 0,
"orderAmount": 0,
"refundCount": 0,
"refundAmount": 0,
"brokerageCount": 0,
"brokerageAmount": 0,
"deductCount": 0,
"deductBrokerage": 0,
"toneUpCount": 0,
"toneUpBrokerage": 0,
"complaintCount": 0,
"agentCount": 0,
"appcode": ""
},
"timestamp": 0,
"traceId": ""
}1.7.用户相关
1.7.1.查询登录信息
Type: GET
Author: wangqidong created on 2024/6/18
Content-Type: application/x-www-form-urlencoded
Description: 查询登录信息
Query-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
mustRefresh | boolean | No comments found. | false | - | true |
Request-example:
curl -X GET -i '/dex/rs/mini/user/querySession?mustRefresh=true'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─loginId | string | 登录id | - | |
└─stoken | string | 登录token | - | |
└─userId | int64 | 用户id | - | 0 |
└─username | string | 用户名 | - | |
└─nickname | string | 昵称 | - | |
└─mobile | string | 手机号 | - | |
└─merchantId | int64 | 当前登录的商户id | - | 0 |
└─merchantName | string | 商户名 | - | |
└─enterpriseId | int64 | 企业id | - | 0 |
└─enterpriseName | string | 企业名称 | - | |
└─industry | string | 所属行业 | - | |
└─authType | int32 | 登录用户认证类型，0-未认证，10-个人认证，20-企业认证 | - | 0 |
└─loginAppCode | string | 登录端code | - | |
└─appcode | string | 当前访问端code | - | |
└─appName | string | 当前访问端名称 | - | |
└─bizAppcode | string | 业务应用编码（适用于管理后台访问业务数据） | - | |
└─requestIp | string | 请求ip | - | |
└─agentId | int64 | 当前应用下代理id | - | 0 |
└─salesmanId | int64 | 销售id | - | 0 |
└─assistantId | int64 | 维护人id | - | 0 |
└─tenantId | int64 | 租户id | - | 0 |
└─bizTenantId | int64 | 业务租户id | - | 0 |
└─tenantOwnerId | int64 | 租户所有者用户id | - | 0 |
└─realName | string | 真实姓名 | - | |
└─linkman | string | 联系人（商户） | - | |
└─linkMobile | string | 联系方式（商户） | - | |
string | 邮箱（商户） | - | ||
└─isTemp | boolean | 是否临时登录 | - | true |
└─terminal | enum | 终端类型，android-安卓，ios-ios，harmony-鸿蒙 | - | ANDROID |
└─iv | int32 | 当前内部版本号 | - | 0 |
└─isTest | boolean | 是否测试用户 | - | true |
└─refreshTime | int64 | 刷新时间戳 | - | 0 |
└─upperAgentId | int64 | 上级代理id | - | 0 |
└─superAgentId | int64 | 总代id | - | 0 |
└─isSuper | boolean | 是否是总代 | - | true |
└─superExpireTime | string | 总代过期时间 | - | yyyy-MM-dd HH:mm:ss |
└─forbitSpread | boolean | 是否禁止推广 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"loginId": "",
"stoken": "",
"userId": 0,
"username": "",
"nickname": "",
"mobile": "",
"merchantId": 0,
"merchantName": "",
"enterpriseId": 0,
"enterpriseName": "",
"industry": "",
"authType": 0,
"loginAppCode": "",
"appcode": "",
"appName": "",
"bizAppcode": "",
"requestIp": "",
"agentId": 0,
"salesmanId": 0,
"assistantId": 0,
"tenantId": 0,
"bizTenantId": 0,
"tenantOwnerId": 0,
"realName": "",
"linkman": "",
"linkMobile": "",
"email": "",
"isTemp": true,
"terminal": "",
"iv": 0,
"isTest": true,
"refreshTime": 0,
"upperAgentId": 0,
"superAgentId": 0,
"isSuper": true,
"superExpireTime": "yyyy-MM-dd HH:mm:ss",
"forbitSpread": true
},
"timestamp": 0,
"traceId": ""
}1.7.2.注册代理
Type: POST
Author: wangqidong created on 2024/6/18
Content-Type: application/json
Description: 注册代理
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
name | string | 姓名 | false | - | |
mobile | string | 手机号 Validation[Pattern(regexp=1[3-9]\d{9})] | true | - | |
idCard | string | 身份证号 Validation[Pattern(regexp=^[1-9][0-9]{5}(18|19|20)[0-9]{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)[0-9]{3}([0-9]|(X|x)))] | false | - | |
smsCode | string | 短信验证码 | true | - | |
wechatOpenid | string | 微信openid | false | - | |
password | string | 密码 | false | - | |
invitationCode | string | 邀请码 | false | - | |
portrait | string | 头像 | false | - | |
nickname | string | 昵称 | false | - | |
redirectUrl | string | 签署完成跳转地址 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/user/register' --data '{
"name": "",
"mobile": "",
"idCard": "",
"smsCode": "",
"wechatOpenid": "",
"password": "",
"invitationCode": "",
"portrait": "",
"nickname": "",
"redirectUrl": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─userId | int64 | 用户id | - | 0 |
└─appcode | string | 应用编码 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证 | - | |
└─mobile | string | 手机号 | - | |
└─agentState | int32 | 代理状态 | - | 0 |
└─contractState | enum | 推广协议签署状态 | - | FAILED |
└─inviteeLevel | int32 | 受邀级别 | - | 0 |
└─upperAgentId | int64 | 上级代理id | - | 0 |
└─agentGrade | string | 代理等级 | - | |
└─invitationCode | string | 邀请码 | - | |
└─defaultRsTemplate | string | 默认风险检测模板 | - | |
└─toneUpAmount | number | 增益金额 | - | 0 |
└─toneUpLocked | boolean | 增益金额是否允许修改 | - | true |
└─toneUpRangeFloor | number | 增益金额修改下限 | - | 0 |
└─toneUpRangeCeiling | number | 增益金额修改上限 | - | 0 |
└─alipayRealName | string | 支付宝真实姓名 | - | |
└─alipayAccount | string | 支付宝帐号 | - | |
└─joinAgentTime | string | 成为代理时间 | - | yyyy-MM-dd HH:mm:ss |
└─beeAppid | string | 诺尔数据appid | - | |
└─beeSecret | string | 诺尔数据secret | - | |
└─bits | enum | 开关配置 | - | IS_TEST |
└─tenantId | int64 | 租户 id | - | 0 |
└─signUrl | string | 协议签署链接 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"userId": 0,
"appcode": "",
"name": "",
"idCard": "",
"mobile": "",
"agentState": 0,
"contractState": 0,
"inviteeLevel": 0,
"upperAgentId": 0,
"agentGrade": "",
"invitationCode": "",
"defaultRsTemplate": "",
"toneUpAmount": 0,
"toneUpLocked": true,
"toneUpRangeFloor": 0,
"toneUpRangeCeiling": 0,
"alipayRealName": "",
"alipayAccount": "",
"joinAgentTime": "yyyy-MM-dd HH:mm:ss",
"beeAppid": "",
"beeSecret": "",
"bits": 0,
"tenantId": 0,
"signUrl": ""
},
"timestamp": 0,
"traceId": ""
}1.7.3.成为代理
Type: POST
Author: wangqidong created on 2024/6/18
Content-Type: application/json
Description: 成为代理
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
name | string | 姓名 | true | - | |
idCard | string | 身份证 Validation[Pattern(regexp=^[1-9][0-9]{5}(18|19|20)[0-9]{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)[0-9]{3}([0-9]|(X|x)))] | false | - | |
mobile | string | 手机号 Validation[Pattern(regexp=1[3-9]\d{9})] | true | - | |
smsCode | string | 验证码 | false | - | |
extra | object | 补充信息 | false | - | |
└─useScene | string | 应用场景 | false | - | |
└─wechatId | string | 微信号 | false | - | |
└─areaCode | string | 所在地区，传递选择的最小一级编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/user/joinAgent' --data '{
"name": "",
"idCard": "",
"mobile": "",
"smsCode": "",
"extra": {
"useScene": "",
"wechatId": "",
"areaCode": ""
}
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─userId | int64 | 用户id | - | 0 |
└─appcode | string | 应用编码 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证 | - | |
└─mobile | string | 手机号 | - | |
└─agentState | int32 | 代理状态 | - | 0 |
└─contractState | enum | 推广协议签署状态 | - | FAILED |
└─inviteeLevel | int32 | 受邀级别 | - | 0 |
└─upperAgentId | int64 | 上级代理id | - | 0 |
└─agentGrade | string | 代理等级 | - | |
└─invitationCode | string | 邀请码 | - | |
└─defaultRsTemplate | string | 默认风险检测模板 | - | |
└─toneUpAmount | number | 增益金额 | - | 0 |
└─toneUpLocked | boolean | 增益金额是否允许修改 | - | true |
└─toneUpRangeFloor | number | 增益金额修改下限 | - | 0 |
└─toneUpRangeCeiling | number | 增益金额修改上限 | - | 0 |
└─alipayRealName | string | 支付宝真实姓名 | - | |
└─alipayAccount | string | 支付宝帐号 | - | |
└─joinAgentTime | string | 成为代理时间 | - | yyyy-MM-dd HH:mm:ss |
└─beeAppid | string | 诺尔数据appid | - | |
└─beeSecret | string | 诺尔数据secret | - | |
└─bits | enum | 开关配置 | - | IS_TEST |
└─tenantId | int64 | 租户 id | - | 0 |
└─signUrl | string | 协议签署链接 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"userId": 0,
"appcode": "",
"name": "",
"idCard": "",
"mobile": "",
"agentState": 0,
"contractState": 0,
"inviteeLevel": 0,
"upperAgentId": 0,
"agentGrade": "",
"invitationCode": "",
"defaultRsTemplate": "",
"toneUpAmount": 0,
"toneUpLocked": true,
"toneUpRangeFloor": 0,
"toneUpRangeCeiling": 0,
"alipayRealName": "",
"alipayAccount": "",
"joinAgentTime": "yyyy-MM-dd HH:mm:ss",
"beeAppid": "",
"beeSecret": "",
"bits": 0,
"tenantId": 0,
"signUrl": ""
},
"timestamp": 0,
"traceId": ""
}1.7.4.招募代理邀请码查询
Type: GET
Author: wangqidong created on 2024/6/18
Content-Type: application/x-www-form-urlencoded
Description: 招募代理邀请码查询
Request-example:
curl -X GET -i '/dex/rs/mini/user/recruitAgentInvitation'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─inviteeMobile | string | 邀请者手机号 | - | |
└─invitationCode | string | 邀请码 | - | |
└─invitationUrl | string | 邀请地址 | - | |
└─invitationQrCode | string | 邀请码二维码 | - | |
└─posterList | array | 海报 | - | """,""" |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"inviteeMobile": "",
"invitationCode": "",
"invitationUrl": "",
"invitationQrCode": "",
"posterList": [
""
]
},
"timestamp": 0,
"traceId": ""
}1.7.5.邀请码信息
Type: GET
Author: wangqidong created on 2024/6/18
Content-Type: application/x-www-form-urlencoded
Description: 邀请码信息
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
invitationCode | string | No comments found. | true | - |
Query-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
requirePoster | boolean | 是否需要海报 | true | - | false |
Request-example:
curl -X GET -i '/dex/rs/mini/user/invitationDetail/{invitationCode}?requirePoster=false'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─inviteeMobile | string | 邀请者手机号 | - | |
└─invitationCode | string | 邀请码 | - | |
└─invitationUrl | string | 邀请地址 | - | |
└─invitationQrCode | string | 邀请码二维码 | - | |
└─posterList | array | 海报 | - | """,""" |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"inviteeMobile": "",
"invitationCode": "",
"invitationUrl": "",
"invitationQrCode": "",
"posterList": [
""
]
},
"timestamp": 0,
"traceId": ""
}1.7.6.编辑用户信息
Type: POST
Author: wangqidong created on 2024/6/18
Content-Type: application/json
Description: 编辑用户信息
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
alipayRealName | string | 支付宝真实姓名 | false | - | |
toneUpAmount | number | 增益金额 | false | - | 0 |
alipayAccount | string | 支付宝帐号 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/user/editInfo' --data '{
"alipayRealName": "",
"toneUpAmount": 0,
"alipayAccount": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}1.7.7.用户数据
Type: GET
Author: wangqidong created on 2024/6/18
Content-Type: application/x-www-form-urlencoded
Description: 用户数据
Query-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
querySimple | boolean | No comments found. | true | - | false |
Request-example:
curl -X GET -i '/dex/rs/mini/user/memberDetail?querySimple=false'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─userId | int64 | 用户id | - | 0 |
└─appcode | string | 应用编码 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证 | - | |
└─mobile | string | 手机号 | - | |
└─agentState | int32 | 代理状态 | - | 0 |
└─contractState | enum | 推广协议签署状态 | - | FAILED |
└─inviteeLevel | int32 | 受邀级别 | - | 0 |
└─upperAgentId | int64 | 上级代理id | - | 0 |
└─agentGrade | string | 代理等级 | - | |
└─invitationCode | string | 邀请码 | - | |
└─defaultRsTemplate | string | 默认风险检测模板 | - | |
└─toneUpAmount | number | 增益金额 | - | 0 |
└─toneUpLocked | boolean | 增益金额是否允许修改 | - | true |
└─toneUpRangeFloor | number | 增益金额修改下限 | - | 0 |
└─toneUpRangeCeiling | number | 增益金额修改上限 | - | 0 |
└─alipayRealName | string | 支付宝真实姓名 | - | |
└─alipayAccount | string | 支付宝帐号 | - | |
└─joinAgentTime | string | 成为代理时间 | - | yyyy-MM-dd HH:mm:ss |
└─beeAppid | string | 诺尔数据appid | - | |
└─beeSecret | string | 诺尔数据secret | - | |
└─bits | enum | 开关配置 | - | IS_TEST |
└─tenantId | int64 | 租户 id | - | 0 |
└─signUrl | string | 协议签署链接 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"userId": 0,
"appcode": "",
"name": "",
"idCard": "",
"mobile": "",
"agentState": 0,
"contractState": 0,
"inviteeLevel": 0,
"upperAgentId": 0,
"agentGrade": "",
"invitationCode": "",
"defaultRsTemplate": "",
"toneUpAmount": 0,
"toneUpLocked": true,
"toneUpRangeFloor": 0,
"toneUpRangeCeiling": 0,
"alipayRealName": "",
"alipayAccount": "",
"joinAgentTime": "yyyy-MM-dd HH:mm:ss",
"beeAppid": "",
"beeSecret": "",
"bits": 0,
"tenantId": 0,
"signUrl": ""
},
"timestamp": 0,
"traceId": ""
}1.7.8.待签署协议
Type: POST
Author: wangqidong created on 2024/6/18
Content-Type: application/json
Description: 暂时只考虑推广者协议
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
protocolCodeList | array | 协议编码 | false | - | """,""" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/user/waitSignProtocols' --data '{
"protocolCodeList": [
""
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─protocolCode | string | 协议编码 | - | |
└─protocolName | string | 协议名称 | - | |
└─isAuthed | boolean | 是否已认证 | - | true |
└─signerName | string | 姓名 | - | |
└─signerMobile | string | 手机号（不可更改） | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"protocolCode": "",
"protocolName": "",
"isAuthed": true,
"signerName": "",
"signerMobile": ""
}
],
"timestamp": 0,
"traceId": ""
}1.7.9.发起协议签署
Type: POST
Author: wangqidong created on 2024/6/18
Content-Type: application/json
Description: 发起协议签署
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
protocolCode | string | 协议编码 | true | - | |
redirectUrl | string | 签署完成跳转地址 | false | - | |
authInfo | object | 认证信息 | false | - | |
└─name | string | 姓名 | true | - | |
└─idCard | string | 身份证 | true | - | |
└─mobile | string | 手机号 | true | - | |
└─smsCode | string | 验证码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/user/applySignProtocol' --data '{
"protocolCode": "",
"redirectUrl": "",
"authInfo": {
"name": "",
"idCard": "",
"mobile": "",
"smsCode": ""
}
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─userId | int64 | 用户id | - | 0 |
└─contractNo | string | 合同编号 | - | |
└─signUrl | string | 签署地址 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"userId": 0,
"contractNo": "",
"signUrl": ""
},
"timestamp": 0,
"traceId": ""
}1.7.10.我的协议
Type: POST
Author: wangqidong created on 2024/6/18
Content-Type: application/json
Description: 我的协议
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
scene | string | 签署场景（签署场景和协议编码不能都为空） | false | - | |
protocolCodeList | array | 协议编码（签署场景和协议编码不能都为空） | false | - | """,""" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/user/mineProtocols' --data '{
"scene": "",
"protocolCodeList": [
""
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─protocolCode | string | 协议编码 | - | |
└─protocolName | string | 协议名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─scene | string | 签署场景 | - | |
└─asignKey | string | 爱签模板key | - | |
└─protocolUrl | string | 协议地址 | - | |
└─protocolBody | string | 协议内容 | - | |
└─protocolVer | string | 协议版本 | - | |
└─appcode | string | 所属appcode | - | |
└─requireSign | boolean | 是否需要签署 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"protocolName": "",
"enable": true,
"scene": "",
"asignKey": "",
"protocolUrl": "",
"protocolBody": "",
"protocolVer": "",
"appcode": "",
"requireSign": true
}
],
"timestamp": 0,
"traceId": ""
}1.7.11.协议信息
Type: GET
Author: wangqidong created on 2024/6/18
Content-Type: application/x-www-form-urlencoded
Description: 协议信息
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
protocolNo | string | No comments found. | true | - |
Request-example:
curl -X GET -i '/dex/rs/mini/user/protocolInfo/{protocolNo}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─protocolNo | string | 协议编号 | - | |
└─protocolCode | string | 协议编码 | - | |
└─protocolName | string | 协议名 | - | |
└─signType | int32 | 签署类型 | - | 0 |
└─userId | int64 | 用户id | - | 0 |
└─orderNo | string | 订单编号 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─state | int32 | 状态 | - | 0 |
└─authSerialNo | string | 认证流水号 | - | |
└─signUrl | string | 签署地址 | - | |
└─contractUrl | string | 合同地址 | - | |
└─finishTime | string | 签署完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─appcode | string | appcode | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"protocolNo": "",
"protocolCode": "",
"protocolName": "",
"signType": 0,
"userId": 0,
"orderNo": "",
"name": "",
"idCard": "",
"mobile": "",
"state": 0,
"authSerialNo": "",
"signUrl": "",
"contractUrl": "",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"appcode": ""
},
"timestamp": 0,
"traceId": ""
}1.7.12.账号注销
Type: POST
Author: wangqidong created on 2024/6/18
Content-Type: application/json
Description: 账号注销
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
smsCode | string | 验证码 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/mini/user/unregister' --data '{
"smsCode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─delayDays | int32 | 延迟天数 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"delayDays": 0
},
"timestamp": 0,
"traceId": ""
}1.7.13.我的会员信息
Type: GET
Author: wangqidong created on 2024/6/18
Content-Type: application/x-www-form-urlencoded
Description: 我的会员信息
Request-example:
curl -X GET -i '/dex/rs/mini/user/vip/mineInfo'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─level | int32 | 当前会员等级 | - | 0 |
└─name | string | 会员等级名称 | - | |
└─icon | string | 等级图标 | - | |
└─color | string | 主题色 | - | |
└─interests | object | 会员权益 | - | |
└─toneUpCeilingUpRate | number | 下级收益上限上浮比例 | - | 0 |
└─onceWithdrawMaxUpRate | number | 单次最高提现金额上浮比例 | - | 0 |
└─dailyWithdrawMaxUpRate | number | 每日最高提现金额上浮比例 | - | 0 |
└─costPriceDownRate | number | 成本价下浮比例 | - | 0 |
└─priceCeilingUpRate | number | 查询价可修改上限上浮比例 | - | 0 |
└─toneUpCeiling | number | 下级收益上限（实时计算，需指定代理） | - | 0 |
└─onceWithdrawMax | number | 单次最高提现金额（实时计算，需指定代理） | - | 0 |
└─dailyWithdrawMax | number | 每日最高提现金额上浮比例（实时计算，需指定代理） | - | 0 |
└─curMonthOrderCount | int32 | 本月报告数 | - | 0 |
└─requireReportCount | int32 | 升级所需报告数 | - | 0 |
└─upMsg | string | 升级提示 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"level": 0,
"name": "",
"icon": "",
"color": "",
"interests": {
"toneUpCeilingUpRate": 0,
"onceWithdrawMaxUpRate": 0,
"dailyWithdrawMaxUpRate": 0,
"costPriceDownRate": 0,
"priceCeilingUpRate": 0,
"toneUpCeiling": 0,
"onceWithdrawMax": 0,
"dailyWithdrawMax": 0
},
"curMonthOrderCount": 0,
"requireReportCount": 0,
"upMsg": ""
},
"timestamp": 0,
"traceId": ""
}1.7.14.会员配置列表
Type: GET
Author: wangqidong created on 2024/6/18
Content-Type: application/x-www-form-urlencoded
Description: 会员配置列表
Request-example:
curl -X GET -i '/dex/rs/mini/user/vip/configList'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─level | int32 | 会员等级 | - | 0 |
└─name | string | 等级名称 | - | |
└─icon | string | 等级图标 | - | |
└─color | string | 主题色 | - | |
└─enable | boolean | 是否启用 | - | true |
└─upRule | object | 晋升规则 | - | |
└─or | boolean | true：任一满足，false：全部满足 | - | true |
└─rules | array | 规则 | - | |
└─code | string | 规则编码，curMonthOrderGe：本月单量>=，seriesMonthOrderLt：连续n月订单量<，complaintRateLt：投诉率<，refundRateLt：退款率< | - | |
└─val | number | 值 | - | 0 |
└─seriesMonth | int32 | 连续月份数 | - | 0 |
└─includeCur | boolean | 是否包含本月，默认false | - | true |
└─downRule | object | 降级规则 | - | |
└─or | boolean | true：任一满足，false：全部满足 | - | true |
└─rules | array | 规则 | - | |
└─code | string | 规则编码，curMonthOrderGe：本月单量>=，seriesMonthOrderLt：连续n月订单量<，complaintRateLt：投诉率<，refundRateLt：退款率< | - | |
└─val | number | 值 | - | 0 |
└─seriesMonth | int32 | 连续月份数 | - | 0 |
└─includeCur | boolean | 是否包含本月，默认false | - | true |
└─interests | object | 会员权益 | - | |
└─toneUpCeilingUpRate | number | 下级收益上限上浮比例 | - | 0 |
└─onceWithdrawMaxUpRate | number | 单次最高提现金额上浮比例 | - | 0 |
└─dailyWithdrawMaxUpRate | number | 每日最高提现金额上浮比例 | - | 0 |
└─costPriceDownRate | number | 成本价下浮比例 | - | 0 |
└─priceCeilingUpRate | number | 查询价可修改上限上浮比例 | - | 0 |
└─toneUpCeiling | number | 下级收益上限（实时计算，需指定代理） | - | 0 |
└─onceWithdrawMax | number | 单次最高提现金额（实时计算，需指定代理） | - | 0 |
└─dailyWithdrawMax | number | 每日最高提现金额上浮比例（实时计算，需指定代理） | - | 0 |
└─editable | boolean | 是否允许修改 | - | true |
└─appcode | string | appcode | - | |
└─upMsg | string | 升级提示 | - | |
└─requireReportCount | int32 | 升级所需报告数 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"level": 0,
"name": "",
"icon": "",
"color": "",
"enable": true,
"upRule": {
"or": true,
"rules": [
{
"code": "",
"val": 0,
"seriesMonth": 0,
"includeCur": true
}
]
},
"downRule": {
"or": true,
"rules": [
{
"code": "",
"val": 0,
"seriesMonth": 0,
"includeCur": true
}
]
},
"interests": {
"toneUpCeilingUpRate": 0,
"onceWithdrawMaxUpRate": 0,
"dailyWithdrawMaxUpRate": 0,
"costPriceDownRate": 0,
"priceCeilingUpRate": 0,
"toneUpCeiling": 0,
"onceWithdrawMax": 0,
"dailyWithdrawMax": 0
},
"editable": true,
"appcode": "",
"upMsg": "",
"requireReportCount": 0
}
],
"timestamp": 0,
"traceId": ""
}2.风险检测管理后台
2.1.代理管理
2.1.1.代理列表
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 代理列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
userIdList | array | 用户id | false | - | "0,0" |
keyword | string | 搜索关键字 | false | - | |
joinAgentTimeGte | string | 加入时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
joinAgentTimeLte | string | 加入时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
upperAgentId | int64 | 上级代理id | false | - | 0 |
appcode | string | 应用编码，无需传递 | false | - | |
excludeTest | boolean | 是否排除测试账号 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"userIdList": [
0
],
"keyword": "",
"joinAgentTimeGte": "yyyy-MM-dd HH:mm:ss",
"joinAgentTimeLte": "yyyy-MM-dd HH:mm:ss",
"upperAgentId": 0,
"appcode": "",
"excludeTest": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─userId | int64 | 用户id | - | 0 |
└─appcode | string | 应用编码 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证 | - | |
└─mobile | string | 手机号 | - | |
└─agentState | int32 | 代理状态 | - | 0 |
└─contractState | enum | 推广协议签署状态 | - | FAILED |
└─inviteeLevel | int32 | 受邀级别 | - | 0 |
└─upperAgentId | int64 | 上级代理id | - | 0 |
└─agentGrade | string | 代理等级 | - | |
└─invitationCode | string | 邀请码 | - | |
└─defaultRsTemplate | string | 默认风险检测模板 | - | |
└─toneUpAmount | number | 增益金额 | - | 0 |
└─toneUpLocked | boolean | 增益金额是否允许修改 | - | true |
└─toneUpRangeFloor | number | 增益金额修改下限 | - | 0 |
└─toneUpRangeCeiling | number | 增益金额修改上限 | - | 0 |
└─alipayRealName | string | 支付宝真实姓名 | - | |
└─alipayAccount | string | 支付宝帐号 | - | |
└─joinAgentTime | string | 成为代理时间 | - | yyyy-MM-dd HH:mm:ss |
└─beeAppid | string | 诺尔数据appid | - | |
└─beeSecret | string | 诺尔数据secret | - | |
└─bits | enum | 开关配置 | - | IS_TEST |
└─tenantId | int64 | 租户 id | - | 0 |
└─signUrl | string | 协议签署链接 | - | |
└─upperAgentName | string | 上级代理姓名 | - | |
└─upperAgentMobile | string | 上级代理手机号 | - | |
└─orderCount | int32 | 已支付订单数量 | - | 0 |
└─orderAmount | number | 已支付订单金额 | - | 0 |
└─agentCount | int32 | 名下代理数量 | - | 0 |
└─brokerageAccountId | int64 | 佣金账户id | - | 0 |
└─operableBrokerage | number | 可提现佣金 | - | 0 |
└─totalBrokerage | number | 累计佣金 | - | 0 |
└─totalDeduct | number | 累计扣除 | - | 0 |
└─complaintCount | int64 | 投诉笔数 | - | 0 |
└─forbidWithdraw | boolean | 是否禁止提现 | - | true |
└─isFixedCost | boolean | 是否固定成本价 | - | true |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"userId": 0,
"appcode": "",
"name": "",
"idCard": "",
"mobile": "",
"agentState": 0,
"contractState": 0,
"inviteeLevel": 0,
"upperAgentId": 0,
"agentGrade": "",
"invitationCode": "",
"defaultRsTemplate": "",
"toneUpAmount": 0,
"toneUpLocked": true,
"toneUpRangeFloor": 0,
"toneUpRangeCeiling": 0,
"alipayRealName": "",
"alipayAccount": "",
"joinAgentTime": "yyyy-MM-dd HH:mm:ss",
"beeAppid": "",
"beeSecret": "",
"bits": 0,
"tenantId": 0,
"signUrl": "",
"upperAgentName": "",
"upperAgentMobile": "",
"orderCount": 0,
"orderAmount": 0,
"agentCount": 0,
"brokerageAccountId": 0,
"operableBrokerage": 0,
"totalBrokerage": 0,
"totalDeduct": 0,
"complaintCount": 0,
"forbidWithdraw": true,
"isFixedCost": true
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}2.1.2.检索代理，最多20条不分页
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 检索代理，最多20条不分页
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
keyword | string | 搜索关键字 | false | - | |
upperAgentId | int64 | 上级代理id | false | - | 0 |
hasSubAgent | boolean | 有下级代理 | false | - | true |
userIdList | array | 用户id列表 | false | - | "0,0" |
appcode | string | 应用编码，无需传递 | false | - | |
excludeTest | boolean | 过滤测试账号 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/search' --data '{
"keyword": "",
"upperAgentId": 0,
"hasSubAgent": true,
"userIdList": [
0
],
"appcode": "",
"excludeTest": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─userId | int64 | 用户id | - | 0 |
└─name | string | 姓名 | - | |
└─mobile | string | 手机号 | - | |
└─upperAgentId | int64 | 上级代理id | - | 0 |
└─agentGrade | string | 代理等级 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"userId": 0,
"name": "",
"mobile": "",
"upperAgentId": 0,
"agentGrade": ""
}
],
"timestamp": 0,
"traceId": ""
}2.1.3.代理详情
Type: GET
Author: wangqidong created on 2024/10/08
Content-Type: application/x-www-form-urlencoded
Description: 代理详情
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | No comments found. | true | - | 0 |
Request-example:
curl -X GET -i '/dex/rs/admin/agent/agentDetail/{userId}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─userId | int64 | 用户id | - | 0 |
└─appcode | string | 应用编码 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证 | - | |
└─mobile | string | 手机号 | - | |
└─agentState | int32 | 代理状态 | - | 0 |
└─contractState | enum | 推广协议签署状态 | - | FAILED |
└─inviteeLevel | int32 | 受邀级别 | - | 0 |
└─upperAgentId | int64 | 上级代理id | - | 0 |
└─agentGrade | string | 代理等级 | - | |
└─invitationCode | string | 邀请码 | - | |
└─defaultRsTemplate | string | 默认风险检测模板 | - | |
└─toneUpAmount | number | 增益金额 | - | 0 |
└─toneUpLocked | boolean | 增益金额是否允许修改 | - | true |
└─toneUpRangeFloor | number | 增益金额修改下限 | - | 0 |
└─toneUpRangeCeiling | number | 增益金额修改上限 | - | 0 |
└─alipayRealName | string | 支付宝真实姓名 | - | |
└─alipayAccount | string | 支付宝帐号 | - | |
└─joinAgentTime | string | 成为代理时间 | - | yyyy-MM-dd HH:mm:ss |
└─beeAppid | string | 诺尔数据appid | - | |
└─beeSecret | string | 诺尔数据secret | - | |
└─bits | enum | 开关配置 | - | IS_TEST |
└─tenantId | int64 | 租户 id | - | 0 |
└─signUrl | string | 协议签署链接 | - | |
└─upperAgentName | string | 上级代理姓名 | - | |
└─upperAgentMobile | string | 上级代理手机号 | - | |
└─orderCount | int32 | 已支付订单数量 | - | 0 |
└─orderAmount | number | 已支付订单金额 | - | 0 |
└─agentCount | int32 | 名下代理数量 | - | 0 |
└─brokerageAccountId | int64 | 佣金账户id | - | 0 |
└─operableBrokerage | number | 可提现佣金 | - | 0 |
└─totalBrokerage | number | 累计佣金 | - | 0 |
└─totalDeduct | number | 累计扣除 | - | 0 |
└─complaintCount | int64 | 投诉笔数 | - | 0 |
└─forbidWithdraw | boolean | 是否禁止提现 | - | true |
└─isFixedCost | boolean | 是否固定成本价 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"userId": 0,
"appcode": "",
"name": "",
"idCard": "",
"mobile": "",
"agentState": 0,
"contractState": 0,
"inviteeLevel": 0,
"upperAgentId": 0,
"agentGrade": "",
"invitationCode": "",
"defaultRsTemplate": "",
"toneUpAmount": 0,
"toneUpLocked": true,
"toneUpRangeFloor": 0,
"toneUpRangeCeiling": 0,
"alipayRealName": "",
"alipayAccount": "",
"joinAgentTime": "yyyy-MM-dd HH:mm:ss",
"beeAppid": "",
"beeSecret": "",
"bits": 0,
"tenantId": 0,
"signUrl": "",
"upperAgentName": "",
"upperAgentMobile": "",
"orderCount": 0,
"orderAmount": 0,
"agentCount": 0,
"brokerageAccountId": 0,
"operableBrokerage": 0,
"totalBrokerage": 0,
"totalDeduct": 0,
"complaintCount": 0,
"forbidWithdraw": true,
"isFixedCost": true
},
"timestamp": 0,
"traceId": ""
}2.1.4.新增代理
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 新增代理
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
name | string | 姓名 | true | - | |
mobile | string | 手机号 Validation[Pattern(regexp=1[3-9]\d{9}, message=手机号格式错误)] | true | - | |
idCard | string | 身份证号 Validation[Pattern(regexp=^[1-9][0-9]{5}(18|19|20)[0-9]{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)[0-9]{3}([0-9]|(X|x)), message=身份证号码格式错误)] | false | - | |
agentGrade | string | 代理等级 | false | - | |
alipayRealName | string | 支付宝真实姓名 | false | - | |
alipayAccount | string | 支付宝帐号 | false | - | |
upperAgentId | int64 | 上级代理id | false | - | 0 |
skipIdentityVerify | boolean | 是否跳过三要素认证 | false | - | true |
allowRepeatIdentity | boolean | 是否允许重复注册 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/addAgent' --data '{
"name": "",
"mobile": "",
"idCard": "",
"agentGrade": "",
"alipayRealName": "",
"alipayAccount": "",
"upperAgentId": 0,
"skipIdentityVerify": true,
"allowRepeatIdentity": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.1.5.计算成本价
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 计算成本价
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - | |
userId | int64 | 用户id | true | - | 0 |
basePoint | number | 基础成本价加点 | false | - | 0 |
salesPrice | number | 销售价 | true | - | 0 |
isFixedCost | boolean | 是否固定成本价 | false | - | true |
appcode | string | 应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/calculateCostPrice' --data '{
"templateCode": "",
"userId": 0,
"basePoint": 0,
"salesPrice": 0,
"isFixedCost": true,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | number | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": 0,
"timestamp": 0,
"traceId": ""
}2.1.6.编辑代理
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 编辑代理
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | 用户id | true | - | 0 |
mobile | string | 手机号，未改动不要传！！！！ | false | - | |
editBase | object | 基本信息编辑 | false | - | |
└─userId | int64 | 用户id，前段无需指定 | false | - | 0 |
└─agentGrade | string | 代理等级 | false | - | |
└─agentState | int32 | 代理状态 | false | - | 0 |
└─alipayRealName | string | 支付宝真实姓名 | false | - | |
└─alipayAccount | string | 支付宝帐号 | false | - | |
└─toneUpRangeFloor | number | 增益金额修改下限 | false | - | 0 |
└─toneUpRangeCeiling | number | 最大增益金额 | false | - | 0 |
└─toneUpAmount | number | 增益金额 | false | - | 0 |
└─appcode | string | 应用编码 | false | - | |
└─adminEdit | boolean | 管理员编辑 | false | - | true |
└─mobile | string | 手机号 | false | - | |
└─isFixedCost | boolean | 是否固定成本价 | false | - | true |
spreadConfigs | array | 推广价格配置明细 | false | - | |
└─templateCode | string | 模板编码 | true | - | |
└─costPrice | number | 成本价 | true | - | 0 |
└─basePoint | number | 成本价上浮金额 | true | - | 0 |
└─upperRoyalty | number | 上级代理分成 | false | - | 0 |
└─salesPrice | number | 推广价 | false | - | 0 |
└─maxEditablePrice | number | 推广价上限 | false | - | 0 |
toneUpConfig | object | 增益配置 | false | - | |
└─toneUpAmount | number | 平台默认增益金额 | false | - | 0 |
└─isLocked | boolean | 是否锁定 | false | - | true |
└─rangeFloor | number | 增益金额修改下限 | false | - | 0 |
└─rangeCeiling | number | 增益金额修改上限 | false | - | 0 |
smsCode | string | 验证码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/editAgent' --data '{
"userId": 0,
"mobile": "",
"editBase": {
"userId": 0,
"agentGrade": "",
"agentState": 0,
"alipayRealName": "",
"alipayAccount": "",
"toneUpRangeFloor": 0,
"toneUpRangeCeiling": 0,
"toneUpAmount": 0,
"appcode": "",
"adminEdit": true,
"mobile": "",
"isFixedCost": true
},
"spreadConfigs": [
{
"templateCode": "",
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"salesPrice": 0,
"maxEditablePrice": 0
}
],
"toneUpConfig": {
"toneUpAmount": 0,
"isLocked": true,
"rangeFloor": 0,
"rangeCeiling": 0
},
"smsCode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.1.7.查询提现配置
Type: GET
Author: wangqidong created on 2024/10/08
Content-Type: application/x-www-form-urlencoded
Description: 查询提现配置
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | 用户id | true | - | 0 |
Request-example:
curl -X GET -i '/dex/rs/admin/agent/queryWithdrawConfig/{userId}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─onceMin | number | 单次最低提现金额 | - | 0 |
└─onceMax | number | 单次最高提现金额 | - | 0 |
└─dailyMax | number | 每日最高提现金额（无需审核） | - | 0 |
└─dailyMaxCount | int32 | 单日最高申请次数 | - | 0 |
└─enableAudit | boolean | 是否启用审核 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"onceMin": 0,
"onceMax": 0,
"dailyMax": 0,
"dailyMaxCount": 0,
"enableAudit": true
},
"timestamp": 0,
"traceId": ""
}2.1.8.保存提现配置
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 保存提现配置
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | No comments found. | true | - | 0 |
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
onceMin | number | 单次最低提现金额 | true | - | 0 |
onceMax | number | 单次最高提现金额 | false | - | 0 |
dailyMax | number | 每日最高提现金额（无需审核） | true | - | 0 |
dailyMaxCount | int32 | 单日最高申请次数 | false | - | 0 |
enableAudit | boolean | 是否启用审核 | false | - | true |
forbidWithdraw | boolean | 是否禁止提现 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/saveWithdrawConfig/{userId}' --data '{
"onceMin": 0,
"onceMax": 0,
"dailyMax": 0,
"dailyMaxCount": 0,
"enableAudit": true,
"forbidWithdraw": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.1.9.佣金手动打款
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 佣金手动打款
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
accountId | int64 | 佣金账户id | true | - | 0 |
amount | number | 打款金额 | true | - | 0 |
withdrawType | enum | 提现方式，10-微信,alipay-支付宝,30-银行卡 | true | - | WALLET |
toAccount | string | 提现账户 wechat：公众号或小程序绑定的openid（不需要传） alipay：支付宝账号 bankCard: 银行卡号 | false | - | |
accountName | string | 银行名称等 | false | - | |
realName | string | 姓名，支付宝、银行卡可能需要实名校验 | false | - | |
remark | string | 备注 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/remitBrokerage' --data '{
"accountId": 0,
"amount": 0,
"withdrawType": "",
"toAccount": "",
"accountName": "",
"realName": "",
"remark": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.1.10.手动增加佣金
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 手动增加佣金
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
accountId | int64 | 佣金账户id | true | - | 0 |
amount | number | 手动增加金额 | true | - | 0 |
remark | string | 备注 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/addBrokerage' --data '{
"accountId": 0,
"amount": 0,
"remark": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.1.11.账户清零
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 账户清零
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | 用户id | true | - | 0 |
accountId | int64 | 佣金账户id | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/clearBrokerage' --data '{
"userId": 0,
"accountId": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.1.12.移除上级代理
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 移除上级代理
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | 用户id | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/removeUpper' --data '{
"userId": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.1.13.注销账号
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 注销账号
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | 用户id | true | - | 0 |
executeTime | string | 执行时间，仅支持选择7天内，为空立即执行 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/unregister' --data '{
"userId": 0,
"executeTime": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─delayDays | int32 | 延迟天数 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"delayDays": 0
},
"timestamp": 0,
"traceId": ""
}2.1.14.变更上级代理
Type: POST
Author: wangqidong created on 2024/10/08
Content-Type: application/json
Description: 变更上级代理
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | 用户id | true | - | 0 |
upperAgentId | int64 | 变更后上级代理id | true | - | 0 |
recalculatePrice | boolean | 是否重新计算价格，默认false | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/agent/changeUpperAgent' --data '{
"userId": 0,
"upperAgentId": 0,
"recalculatePrice": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.2.订单管理
2.2.1.订单列表
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 订单列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
orderNo | string | 订单编号 | false | - | |
orderNoList | array | 订单编号 | false | - | """,""" |
payNo | string | 支付单号 | false | - | |
keyword | string | 搜索关键字 | false | - | |
stateList | array | 订单状态 | false | - | "0,0" |
agentId | int64 | 代理id | false | - | 0 |
templateCodeList | array | 模板编号 | false | - | """,""" |
createTimeGte | string | 创建时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 创建时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"orderNo": "",
"orderNoList": [
""
],
"payNo": "",
"keyword": "",
"stateList": [
0
],
"agentId": 0,
"templateCodeList": [
""
],
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
└─orderCount | int32 | 订单数量 | - | 0 |
└─orderAmountSum | number | 订单金额 | - | 0 |
└─splitBrokerageAmountSum | number | 分佣金额 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"userId": 0,
"orderNo": "",
"seqNo": "",
"submitType": 0,
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"surveyObject": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"orderAmount": 0,
"splitBrokerageAmount": 0,
"couponAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payNo": "",
"payMethod": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"expiredTime": "yyyy-MM-dd HH:mm:ss",
"agentId": 0,
"agentName": "",
"agentMobile": "",
"appcode": ""
}
],
"isLarge": true,
"orderCount": 0,
"orderAmountSum": 0,
"splitBrokerageAmountSum": 0
},
"timestamp": 0,
"traceId": ""
}2.2.2.订单详情
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 订单详情
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/detail' --data '{
"orderNo": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─userId | int64 | 用户id（扫码下单不登录没有用户，此时是代理的id） | - | 0 |
└─orderNo | string | 订单编号 | - | |
└─seqNo | string | 流水号 | - | |
└─submitType | int32 | 下单方式，10-直查，20-扫码查询 | - | 0 |
└─state | int32 | 订单状态 | - | 0 |
└─payState | int32 | 支付状态 | - | 0 |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─plateNumber | string | 车牌号 | - | |
└─vin | string | 车架号 | - | |
└─surveyObject | string | 查询对象 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─splitBrokerageAmount | number | 分佣金额 | - | 0 |
└─couponAmount | number | 优惠券抵扣金额 | - | 0 |
└─paidAmount | number | 实付金额 | - | 0 |
└─refundAmount | number | 订单已退款金额 | - | 0 |
└─payNo | string | 支付单号 | - | |
└─payMethod | string | 支付方式 | - | |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 实际完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─expiredTime | string | 过期时间 | - | yyyy-MM-dd HH:mm:ss |
└─agentId | int64 | 代理id | - | 0 |
└─agentName | string | 代理名称 | - | |
└─agentMobile | string | 代理手机号 | - | |
└─appcode | string | 应用编码 | - | |
└─brokerageDetails | array | 分佣明细 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─accountId | int64 | 佣金账户id | - | 0 |
└─userId | int64 | 用户id | - | 0 |
└─orderNo | string | 业务订单号 | - | |
└─orderAmount | number | 订单金额 | - | 0 |
└─totalSplitAmount | number | 总分佣金额 | - | 0 |
└─brokerageRate | number | 佣金比例 | - | 0 |
└─brokerageAmount | number | 佣金 | - | 0 |
└─state | int32 | 状态 | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─directUserInfo | string | 推广代理信息，姓名 + 手机号脱敏 | - | |
└─autoSettle | boolean | 是否自动结算 | - | true |
└─settleTime | string | 结算时间 | - | yyyy-MM-dd HH:mm:ss |
└─deductTime | string | 扣除时间 | - | yyyy-MM-dd HH:mm:ss |
└─description | string | 描述 | - | |
└─extra | string | 扩展数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"userId": 0,
"orderNo": "",
"seqNo": "",
"submitType": 0,
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"surveyObject": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"orderAmount": 0,
"splitBrokerageAmount": 0,
"couponAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payNo": "",
"payMethod": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"expiredTime": "yyyy-MM-dd HH:mm:ss",
"agentId": 0,
"agentName": "",
"agentMobile": "",
"appcode": "",
"brokerageDetails": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"accountId": 0,
"userId": 0,
"orderNo": "",
"orderAmount": 0,
"totalSplitAmount": 0,
"brokerageRate": 0,
"brokerageAmount": 0,
"state": 0,
"directUserId": 0,
"directUserInfo": "",
"autoSettle": true,
"settleTime": "yyyy-MM-dd HH:mm:ss",
"deductTime": "yyyy-MM-dd HH:mm:ss",
"description": "",
"extra": ""
}
]
},
"timestamp": 0,
"traceId": ""
}2.2.3.删除订单
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 删除订单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/delete' --data '{
"orderNo": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.2.4.分布统计
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 分布统计
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNoList | array | 订单号，订单号和支付单号二选一 | false | - | """,""" |
payNoList | array | 支付单号，订单号和支付单号二选一 | false | - | """,""" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/distributionStatistics' --data '{
"orderNoList": [
""
],
"payNoList": [
""
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─userId | int64 | 用户id | - | 0 |
└─agentName | string | 代理姓名 | - | |
└─agentMobile | string | 代理手机号 | - | |
└─count | int32 | 数量 | - | 0 |
└─totalOrderCount | int32 | 总订单量 | - | 0 |
└─totalRefundCount | int32 | 总退款数量 | - | 0 |
└─operableBrokerage | number | 剩余佣金 | - | 0 |
└─orderList | array | 订单列表 | - | |
└─userId | int64 | 用户id（扫码下单不登录没有用户，此时是代理的id） | - | 0 |
└─orderNo | string | 订单编号 | - | |
└─seqNo | string | 流水号 | - | |
└─submitType | int32 | 下单方式，10-直查，20-扫码查询 | - | 0 |
└─state | int32 | 订单状态 | - | 0 |
└─payState | int32 | 支付状态 | - | 0 |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─plateNumber | string | 车牌号 | - | |
└─vin | string | 车架号 | - | |
└─surveyObject | string | 查询对象 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─splitBrokerageAmount | number | 分佣金额 | - | 0 |
└─couponAmount | number | 优惠券抵扣金额 | - | 0 |
└─paidAmount | number | 实付金额 | - | 0 |
└─refundAmount | number | 订单已退款金额 | - | 0 |
└─payNo | string | 支付单号 | - | |
└─payMethod | string | 支付方式 | - | |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 实际完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─expiredTime | string | 过期时间 | - | yyyy-MM-dd HH:mm:ss |
└─agentId | int64 | 代理id | - | 0 |
└─agentName | string | 代理名称 | - | |
└─agentMobile | string | 代理手机号 | - | |
└─appcode | string | 应用编码 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"userId": 0,
"agentName": "",
"agentMobile": "",
"count": 0,
"totalOrderCount": 0,
"totalRefundCount": 0,
"operableBrokerage": 0,
"orderList": [
{
"userId": 0,
"orderNo": "",
"seqNo": "",
"submitType": 0,
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"surveyObject": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"orderAmount": 0,
"splitBrokerageAmount": 0,
"couponAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payNo": "",
"payMethod": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"expiredTime": "yyyy-MM-dd HH:mm:ss",
"agentId": 0,
"agentName": "",
"agentMobile": "",
"appcode": ""
}
]
}
],
"timestamp": 0,
"traceId": ""
}2.2.5.订单退款
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 订单退款
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | true | - | |
addBlacklist | boolean | 是否添加黑名单，默认false | false | - | true |
disputeType | string | 争议类型 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/disputeRefund' --data '{
"orderNo": "",
"addBlacklist": true,
"disputeType": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.2.6.批量退款
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 批量退款
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNoList | array | 订单号，订单号和支付单号二选一 | false | - | """,""" |
payNoList | array | 支付单号，订单号和支付单号二选一 | false | - | """,""" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/disputeRefundBatch' --data '{
"orderNoList": [
""
],
"payNoList": [
""
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.2.7.分享报告
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 分享报告
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/shareReport' --data '{
"orderNo": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─shareCode | string | 分享码 | - | |
└─shareUrl | string | 分享地址 | - | |
└─validDays | int32 | 有效天数 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"shareCode": "",
"shareUrl": "",
"validDays": 0
},
"timestamp": 0,
"traceId": ""
}2.2.8.恢复过期订单
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 恢复过期订单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/recoverOrder' --data '{
"orderNo": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.2.9.查询黑名单
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 查询黑名单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
keyword | string | 查询关键字 | false | - | |
appcode | string | 应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/queryBlacklist' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"keyword": "",
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─name | string | 用户姓名 | - | |
└─idCard | string | 身份证号 | - | |
└─mobile | string | 手机号 | - | |
└─violateCount | int32 | 触发违规次数 | - | 0 |
└─lastViolateTime | string | 最后一次违规时间 | - | yyyy-MM-dd HH:mm:ss |
└─isEffected | boolean | 是否有效 | - | true |
└─appcode | string | 应用编码 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"name": "",
"idCard": "",
"mobile": "",
"violateCount": 0,
"lastViolateTime": "yyyy-MM-dd HH:mm:ss",
"isEffected": true,
"appcode": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}2.2.10.加入黑名单
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 加入黑名单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
bizNoList | array | 业务单号列表，订单号或者支付单号 | false | - | """,""" |
manualList | array | 手动添加列表 | false | - | |
└─name | string | 姓名 | false | - | |
└─idCard | string | 身份证号码 | false | - | |
└─mobile | string | 手机号 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/addBlacklist' --data '{
"bizNoList": [
""
],
"manualList": [
{
"name": "",
"idCard": "",
"mobile": ""
}
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.2.11.移除黑名单
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 移除黑名单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | id | true | - | 0 |
appcode | string | 应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/removeBlacklist' --data '{
"id": 0,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.2.12.手动生成授权书
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 手动生成授权书
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
mapKey | string | A map key. | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/order/generateAuthProtocol' --data '{
"mapKey1": "",
"mapKey2": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | string | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": "",
"timestamp": 0,
"traceId": ""
}2.3.客诉管理
2.3.1.查询投诉单列表
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 查询投诉单列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
userIdList | array | 代理id | false | - | "0,0" |
mobile | string | 投诉人手机号 | false | - | |
keyword | string | 搜索关键字 | false | - | |
stateList | array | 状态 | false | - | "0,0" |
templateCodeList | array | 模板编码 | false | - | """,""" |
isPlatProcess | boolean | 是否平台处理 | false | - | true |
createTimeGte | string | 发起投诉时间起始时间 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 发起投诉时间截止时间 | false | - | yyyy-MM-dd HH:mm:ss |
effectTimeGte | string | 投诉生效时间起始时间 | false | - | yyyy-MM-dd HH:mm:ss |
effectTimeLte | string | 投诉生效时间截止时间 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/complaint/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"userIdList": [
0
],
"mobile": "",
"keyword": "",
"stateList": [
0
],
"templateCodeList": [
""
],
"isPlatProcess": true,
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss",
"effectTimeGte": "yyyy-MM-dd HH:mm:ss",
"effectTimeLte": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─channel | string | 投诉渠道，plat：平台投诉，alipay：支付宝，wechat：微信 | - | |
└─mobile | string | 投诉人手机号 | - | |
└─complaintType | string | 投诉类型 | - | |
└─complaintContent | string | 投诉内容 | - | |
└─complaintImgList | array | 投诉证明照片，多个逗号分割 | - | """,""" |
└─orderCount | int32 | 订单数量 | - | 0 |
└─currUserOrderCount | int32 | 当前查询用户关联订单数量 | - | 0 |
└─state | int32 | 状态 | - | 0 |
└─effectTime | string | 投诉生效时间 | - | yyyy-MM-dd HH:mm:ss |
└─processEndTime | string | 处理截止时间，超时平台将自动处理 | - | yyyy-MM-dd HH:mm:ss |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─complaintAmount | number | 投诉金额 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额（包含上级佣金） | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─thirdId | string | 第三方投诉单id | - | |
└─linkMobile | string | 联系方式 | - | |
└─auditRemark | string | 审核备注 | - | |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─details | array | 明细，详情接口才会返回 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─complaintId | int64 | 投诉单id | - | 0 |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─userId | int64 | 用户id（代理id） | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─thirdTradeNo | string | 第三方交易单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─refundFlag | int32 | 退款标识，0-未处理，10-无需退款，20-已退款 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额 | - | 0 |
└─directBrokerage | number | 直接上级佣金 | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─processType | string | 处理类型 | - | |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─agentInfo | string | 代理信息 | - | |
└─surveyObject | string | 查询对象 | - | |
└─orderCreateTime | string | 订单创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"channel": "",
"mobile": "",
"complaintType": "",
"complaintContent": "",
"complaintImgList": [
""
],
"orderCount": 0,
"currUserOrderCount": 0,
"state": 0,
"effectTime": "yyyy-MM-dd HH:mm:ss",
"processEndTime": "yyyy-MM-dd HH:mm:ss",
"processTime": "yyyy-MM-dd HH:mm:ss",
"isPlatProcess": true,
"complaintAmount": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"refundAmount": 0,
"thirdId": "",
"linkMobile": "",
"auditRemark": "",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"details": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"complaintId": 0,
"orderNo": "",
"payNo": "",
"userId": 0,
"templateCode": "",
"templateName": "",
"thirdTradeNo": "",
"state": 0,
"isPlatProcess": true,
"refundFlag": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"directBrokerage": 0,
"refundAmount": 0,
"processType": "",
"processTime": "yyyy-MM-dd HH:mm:ss",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"surveyType": 0,
"agentInfo": "",
"surveyObject": "",
"orderCreateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}2.3.2.详情
Type: GET
Author: wangqidong created on 2025/5/16
Content-Type: application/x-www-form-urlencoded
Description: 详情
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
complaintId | int64 | No comments found. | true | - | 0 |
Request-example:
curl -X GET -i '/dex/rs/admin/complaint/detail/{complaintId}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─channel | string | 投诉渠道，plat：平台投诉，alipay：支付宝，wechat：微信 | - | |
└─mobile | string | 投诉人手机号 | - | |
└─complaintType | string | 投诉类型 | - | |
└─complaintContent | string | 投诉内容 | - | |
└─complaintImgList | array | 投诉证明照片，多个逗号分割 | - | """,""" |
└─orderCount | int32 | 订单数量 | - | 0 |
└─currUserOrderCount | int32 | 当前查询用户关联订单数量 | - | 0 |
└─state | int32 | 状态 | - | 0 |
└─effectTime | string | 投诉生效时间 | - | yyyy-MM-dd HH:mm:ss |
└─processEndTime | string | 处理截止时间，超时平台将自动处理 | - | yyyy-MM-dd HH:mm:ss |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─complaintAmount | number | 投诉金额 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额（包含上级佣金） | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─thirdId | string | 第三方投诉单id | - | |
└─linkMobile | string | 联系方式 | - | |
└─auditRemark | string | 审核备注 | - | |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─details | array | 明细，详情接口才会返回 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─complaintId | int64 | 投诉单id | - | 0 |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─userId | int64 | 用户id（代理id） | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─thirdTradeNo | string | 第三方交易单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─isPlatProcess | boolean | 是否平台处理 | - | true |
└─refundFlag | int32 | 退款标识，0-未处理，10-无需退款，20-已退款 | - | 0 |
└─paidAmount | number | 订单实付金额 | - | 0 |
└─brokerageAmount | number | 订单分佣金额 | - | 0 |
└─directBrokerage | number | 直接上级佣金 | - | 0 |
└─refundAmount | number | 退款金额 | - | 0 |
└─processType | string | 处理类型 | - | |
└─processTime | string | 处理时间 | - | yyyy-MM-dd HH:mm:ss |
└─processRemark | string | 处理备注 | - | |
└─processImgList | array | 处理附件照片 | - | """,""" |
└─appcode | string | appcode | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─agentInfo | string | 代理信息 | - | |
└─surveyObject | string | 查询对象 | - | |
└─orderCreateTime | string | 订单创建时间 | - | yyyy-MM-dd HH:mm:ss |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"channel": "",
"mobile": "",
"complaintType": "",
"complaintContent": "",
"complaintImgList": [
""
],
"orderCount": 0,
"currUserOrderCount": 0,
"state": 0,
"effectTime": "yyyy-MM-dd HH:mm:ss",
"processEndTime": "yyyy-MM-dd HH:mm:ss",
"processTime": "yyyy-MM-dd HH:mm:ss",
"isPlatProcess": true,
"complaintAmount": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"refundAmount": 0,
"thirdId": "",
"linkMobile": "",
"auditRemark": "",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"details": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"complaintId": 0,
"orderNo": "",
"payNo": "",
"userId": 0,
"templateCode": "",
"templateName": "",
"thirdTradeNo": "",
"state": 0,
"isPlatProcess": true,
"refundFlag": 0,
"paidAmount": 0,
"brokerageAmount": 0,
"directBrokerage": 0,
"refundAmount": 0,
"processType": "",
"processTime": "yyyy-MM-dd HH:mm:ss",
"processRemark": "",
"processImgList": [
""
],
"appcode": "",
"surveyType": 0,
"agentInfo": "",
"surveyObject": "",
"orderCreateTime": "yyyy-MM-dd HH:mm:ss"
}
]
},
"timestamp": 0,
"traceId": ""
}2.3.3.审核
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 审核
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
complaintId | int64 | 投诉单id | true | - | 0 |
auditType | string | 审核类型，pass:通过，reject:驳回 | true | - | |
auditRemark | string | 审核备注（驳回原因） Validation[Length(max=200, min=0, message=最多输入200个字符)] | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/complaint/audit' --data '{
"complaintId": 0,
"auditType": "",
"auditRemark": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.3.4.处理投诉
Type: POST
Author: wangqidong created on 2025/5/16
Content-Type: application/json
Description: 处理投诉
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
complaintId | int64 | 投诉单id | true | - | 0 |
detailIds | array | 明细id，为空代表处理投诉单下所有订单 | false | - | "0,0" |
processType | enum | 处理类型，refund：退款，offline：线下协商撤诉 | true | - | REFUND |
remark | string | 备注 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/complaint/process' --data '{
"complaintId": 0,
"detailIds": [
0
],
"processType": "",
"remark": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.4.模板管理
2.4.1.查询模板
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 查询模板
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
userId | int64 | 用户id | false | - | 0 |
excludeFree | boolean | 是否过滤免费模板 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/template/queryList' --data '{
"userId": 0,
"excludeFree": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─parentTemplateCode | string | 上级模板编码 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
└─upperRoyalty | number | 上级代理分成 | - | 0 |
└─superRoyalty | number | 总代分成 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─brokerageDetail | object | 佣金信息 | - | |
└─userId | int64 | 用户id | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─brokerage | number | 佣金 | - | 0 |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─sort | int32 | No comments found. | - | 0 |
└─subTemplates | array | No comments found. | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"parentTemplateCode": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"superRoyalty": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"brokerageDetail": {
"userId": 0,
"directUserId": 0,
"brokerage": 0
},
"spreadUserId": 0,
"spreadCode": "",
"sort": 0,
"subTemplates": [
{
"$ref": ".."
}
]
}
],
"timestamp": 0,
"traceId": ""
}2.4.2.全局价格配置
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 全局价格配置
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - | |
costPrice | number | 成本价 | true | - | 0 |
basePoint | number | 成本价上浮金额 | true | - | 0 |
upperRoyalty | number | 上级代理分成 | false | - | 0 |
salesPrice | number | 推广价 | false | - | 0 |
maxEditablePrice | number | 推广价上限 | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/template/priceConfig' --data '[
{
"templateCode": "",
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"salesPrice": 0,
"maxEditablePrice": 0
}
]'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.5.推广管理
2.5.1.提现记录
Type: POST
Author: wangqidong created on 2024/10/14
Content-Type: application/json
Description: 提现记录
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
userId | int64 | 用户id | false | - | 0 |
withdrawType | string | 提现方式 | false | - | |
stateList | array | 提现状态 | false | - | "0,0" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/spread/withdrawList' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"userId": 0,
"withdrawType": "",
"stateList": [
0
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─withdrawNo | string | 提现单号 | - | |
└─userId | int64 | 用户id | - | 0 |
└─agentName | string | 代理名称 | - | |
└─agentMobile | string | 代理手机号 | - | |
└─withdrawType | string | 提现方式 | - | |
└─withdrawAmount | number | 提现金额 | - | 0 |
└─state | int32 | 提现状态 | - | 0 |
└─auditMode | string | 审核方式，system-系统，manual-人工 | - | |
└─rejectReason | string | 驳回原因 | - | |
└─toAccount | string | 提现账户 | - | |
└─finishTime | string | 提现完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─remark | string | 备注 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"withdrawNo": "",
"userId": 0,
"agentName": "",
"agentMobile": "",
"withdrawType": "",
"withdrawAmount": 0,
"state": 0,
"auditMode": "",
"rejectReason": "",
"toAccount": "",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"remark": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}2.5.2.提现审核
Type: POST
Author: wangqidong created on 2024/10/14
Content-Type: application/json
Description: 提现审核
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
bizNo | string | 具体业务单号 | true | - | |
auditType | string | 审核类型，pass-通过，reject-拒绝 | true | - | |
rejectReason | string | 拒绝原因 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/spread/withdrawAudit' --data '{
"bizNo": "",
"auditType": "",
"rejectReason": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.6.公告管理
2.6.1.公告列表
Type: POST
Author: wangqidong created on 2024/10/12
Content-Type: application/json
Description: 公告列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
keyword | string | 搜索关键字 | false | - | |
stateList | array | 状态 | false | - | "0,0" |
visibleType | int32 | 可见范围，10-站内，20-指定用户 | false | - | 0 |
effectTimeGte | string | 生效时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
effectTimeLte | string | 生效时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/inform/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"keyword": "",
"stateList": [
0
],
"visibleType": 0,
"effectTimeGte": "yyyy-MM-dd HH:mm:ss",
"effectTimeLte": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─title | string | 标题 | - | |
└─content | string | 内容 | - | |
└─jumpUrl | string | 跳转地址 | - | |
└─state | int32 | 状态 | - | 0 |
└─visibleType | int32 | 可见范围，10-站内，20-指定用户 | - | 0 |
└─visibleUserIdList | array | 可见用户id | - | "0,0" |
└─pushTypeList | array | 推送方式，1-站内通知，2-app通知，3-短信，4-邮件，多个逗号分割 | - | "0,0" |
└─effectTime | string | 生效时间 | - | yyyy-MM-dd HH:mm:ss |
└─invalidTime | string | 失效时间 | - | yyyy-MM-dd HH:mm:ss |
└─appcode | string | 可见应用范围，为空默认全部可见 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"title": "",
"content": "",
"jumpUrl": "",
"state": 0,
"visibleType": 0,
"visibleUserIdList": [
0
],
"pushTypeList": [
0
],
"effectTime": "yyyy-MM-dd HH:mm:ss",
"invalidTime": "yyyy-MM-dd HH:mm:ss",
"appcode": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}2.6.2.新增公告
Type: POST
Author: wangqidong created on 2024/10/12
Content-Type: application/json
Description: 新增公告
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
title | string | 标题 | false | - | |
content | string | 内容 | false | - | |
state | int32 | 状态 | false | - | 0 |
visibleType | int32 | 可见范围，10-全部，20-指定用户 | false | - | 0 |
userIds | array | 推送用户id | false | - | "0,0" |
pushTypeList | array | 推送方式，1-站内通知，2-app通知，3-短信，4-邮件，多个逗号分割 | false | - | "0,0" |
invalidTime | string | 失效时间 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/inform/add' --data '{
"title": "",
"content": "",
"state": 0,
"visibleType": 0,
"userIds": [
0
],
"pushTypeList": [
0
],
"invalidTime": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.6.3.修改状态
Type: POST
Author: wangqidong created on 2024/10/12
Content-Type: application/json
Description: 修改状态
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | 消息id | true | - | 0 |
state | int32 | 状态 | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/inform/editState' --data '{
"id": 0,
"state": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.6.4.删除公告
Type: POST
Author: wangqidong created on 2024/10/12
Content-Type: application/json
Description: 删除公告
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | id | true | - | 0 |
appcode | string | 应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/inform/delete' --data '{
"id": 0,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.平台配置
2.7.1.平台信息
Type: GET
Author: wangqidong created on 2024/10/10
Content-Type: application/x-www-form-urlencoded
Description: 平台信息
Request-example:
curl -X GET -i '/dex/rs/admin/platform/platformInfo'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─platformName | string | 平台名称 | - | |
└─logo | string | logo | - | |
└─toneUpConfig | object | 全局增益配置 | - | |
└─toneUpAmount | number | 平台默认增益金额 | - | 0 |
└─isLocked | boolean | 是否锁定 | - | true |
└─rangeFloor | number | 增益金额修改下限 | - | 0 |
└─rangeCeiling | number | 增益金额修改上限 | - | 0 |
└─withdrawConfig | object | 全局提现配置 | - | |
└─onceMin | number | 单次最低提现金额 | - | 0 |
└─onceMax | number | 单次最高提现金额 | - | 0 |
└─dailyMax | number | 每日最高提现金额（无需审核） | - | 0 |
└─dailyMaxCount | int32 | 单日最高申请次数 | - | 0 |
└─enableAudit | boolean | 是否启用审核 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"platformName": "",
"logo": "",
"toneUpConfig": {
"toneUpAmount": 0,
"isLocked": true,
"rangeFloor": 0,
"rangeCeiling": 0
},
"withdrawConfig": {
"onceMin": 0,
"onceMax": 0,
"dailyMax": 0,
"dailyMaxCount": 0,
"enableAudit": true
}
},
"timestamp": 0,
"traceId": ""
}2.7.2.更改全局增益配置
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 更改全局增益配置
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
toneUpAmount | number | 平台默认增益金额 | false | - | 0 |
isLocked | boolean | 是否锁定 | false | - | true |
rangeFloor | number | 增益金额修改下限 | false | - | 0 |
rangeCeiling | number | 增益金额修改上限 | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/editToneUpConfig' --data '{
"toneUpAmount": 0,
"isLocked": true,
"rangeFloor": 0,
"rangeCeiling": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.3.更改全局提现配置
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 更改全局提现配置
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
onceMin | number | 单次最低提现金额 | true | - | 0 |
onceMax | number | 单次最高提现金额 | false | - | 0 |
dailyMax | number | 每日最高提现金额（无需审核） | true | - | 0 |
dailyMaxCount | int32 | 单日最高申请次数 | false | - | 0 |
enableAudit | boolean | 是否启用审核 | false | - | true |
forbidWithdraw | boolean | 是否禁止提现 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/editWithdrawConfig' --data '{
"onceMin": 0,
"onceMax": 0,
"dailyMax": 0,
"dailyMaxCount": 0,
"enableAudit": true,
"forbidWithdraw": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.4.查询佣金账户
Type: GET
Author: wangqidong created on 2024/10/10
Content-Type: application/x-www-form-urlencoded
Description: 查询佣金账户
Request-example:
curl -X GET -i '/dex/rs/admin/platform/apiAccount'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 钱包id | - | 0 |
└─userId | int64 | 用户id | - | 0 |
└─accountName | string | 账户名 | - | |
└─accountType | int32 | 账户类型，10-个人账户，20-企业账户 | - | 0 |
└─isDefault | boolean | 是否默认钱包 | - | true |
└─state | int32 | 钱包状态，-1-已锁定，0-待开通，10-正常 | - | 0 |
└─balance | number | 账户余额 | - | 0 |
└─overdraftState | int32 | 后付状态，-1-已锁定，0-预充值（不允许超支），10-预充值（允许超支），20-月结 | - | 0 |
└─overdraftQuota | number | 可透支额度 | - | 0 |
└─forewarnThreshold | number | 预警阈值 | - | 0 |
└─forewarnContactList | array | 预警联系人信息 | - | |
└─id | int64 | 联系人id | - | 0 |
└─linkman | string | 联系人姓名 | - | |
└─mobile | string | 联系电话 Validation[Pattern(regexp=1[3-9]\d{9})] | - | |
string | 邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))] | - | ||
└─webhook | string | webhook | - | |
└─isDefault | boolean | 是否默认联系人 | - | true |
└─payRouteList | array | 支付路由列表 | - | |
└─appcode | string | 专属应用编码 | - | |
└─appName | string | 专属应用名称 | - | |
└─properSceneList | array | 专属场景 | - | """,""" |
└─tenantId | int64 | 租户id | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"userId": 0,
"accountName": "",
"accountType": 0,
"isDefault": true,
"state": 0,
"balance": 0,
"overdraftState": 0,
"overdraftQuota": 0,
"forewarnThreshold": 0,
"forewarnContactList": [
{
"id": 0,
"linkman": "",
"mobile": "",
"email": "",
"webhook": "",
"isDefault": true
}
],
"payRouteList": [
{
"appcode": "",
"appName": "",
"properSceneList": [
""
]
}
],
"tenantId": 0
},
"timestamp": 0,
"traceId": ""
}2.7.5.查询所有平台联系人
Type: GET
Author: wangqidong created on 2024/10/10
Content-Type: application/x-www-form-urlencoded
Description: 查询所有平台联系人
Request-example:
curl -X GET -i '/dex/rs/admin/platform/queryAllContacts'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 联系人id | - | 0 |
└─linkman | string | 联系人姓名 | - | |
└─mobile | string | 联系电话 Validation[Pattern(regexp=1[3-9]\d{9})] | - | |
string | 邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))] | - | ||
└─webhook | string | webhook | - | |
└─isDefault | boolean | 是否默认联系人 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"linkman": "",
"mobile": "",
"email": "",
"webhook": "",
"isDefault": true
}
],
"timestamp": 0,
"traceId": ""
}2.7.6.新增联系人
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 新增联系人
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | 联系人id | false | - | 0 |
linkman | string | 联系人姓名 | false | - | |
mobile | string | 联系电话 Validation[Pattern(regexp=1[3-9]\d{9})] | false | - | |
string | 邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))] | false | - | ||
webhook | string | webhook | false | - | |
isDefault | boolean | 是否默认联系人 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/addContacts' --data '{
"id": 0,
"linkman": "",
"mobile": "",
"email": "",
"webhook": "",
"isDefault": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.7.删除联系人
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 删除联系人
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | id | true | - | 0 |
appcode | string | 应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/deleteContacts' --data '{
"id": 0,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.8.配置API账户余额预警
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 配置API账户余额预警
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
walletId | int64 | 钱包id | true | - | 0 |
forewarnThreshold | number | 预警阈值 Validation[DecimalMin(value=0, message=预警阈值不能低于0); DecimalMax(value=100000, message=预警阈值不能超过100000)] | true | - | 0 |
forewarnContactList | array | 预警联系人id | true | - | "0,0" |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/configWalletForewarn' --data '{
"walletId": 0,
"forewarnThreshold": 0,
"forewarnContactList": [
0
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.9.申请充值
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 申请充值
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
walletId | int64 | 账户id，未指定取登录用户匹配 | false | - | 0 |
rechargeAmount | number | 充值金额金额 | true | - | 0 |
payMethod | enum | 支付方式 | false | - | WALLET |
payerOpenid | string | 支付人openid | false | - | |
applyAppType | string | 申请的支付端类型，mini：小程序，wechatMp：微信公众号，pc：pc网站，app：app，h5：h5 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/applyRecharge' --data '{
"walletId": 0,
"rechargeAmount": 0,
"payMethod": "",
"payerOpenid": "",
"applyAppType": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─payNo | string | 支付单号 | - | |
└─payType | string | 业务类型，pay-支付，recharge-账户充值，refund-退款 | - | |
└─payMethod | string | 支付方式 | - | |
└─businessType | string | 业务类型（业务方指定） | - | |
└─businessNo | string | 业务单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─feeName | string | 费用项名称 | - | |
└─originAmount | number | 原始金额 | - | 0 |
└─amount | number | 需支付金额 | - | 0 |
└─applyPayResult | object | 申请支付结果（传递了支付方式会返回） | - | |
└─isPaid | boolean | 是否已支付 | - | true |
└─logo | string | Logo | - | |
└─payData | object | 支付数据 | - | |
└─logo | string | Logo | - | |
└─expireSeconds | int32 | 剩余可支付时间（秒） | - | 0 |
└─payUrl | string | 支付地址 | - | |
└─payInfo | string | 支付信息 | - | |
└─wechatPayExtra | object | 微信支付额外字段 | - | |
└─appId | string | appid | - | |
└─timeStamp | string | 时间戳 | - | |
└─nonceStr | string | 随机字符串 | - | |
└─package | string | 支付地址 | - | |
└─signType | string | 签名类型，默认为RSA，仅支持RSA。 | - | |
└─paySign | string | 签名 | - | |
└─payAccountId | int64 | No comments found. | - | 0 |
└─walletFlowNo | string | 钱包流水编号，钱包支付会记录 | - | |
└─extraData | object | 额外数据 | - | |
└─giveQuota | number | 赠送金额 | - | 0 |
└─onlyNewGive | boolean | 赠送金额是否新客专享 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"payNo": "",
"payType": "",
"payMethod": "",
"businessType": "",
"businessNo": "",
"state": 0,
"feeName": "",
"originAmount": 0,
"amount": 0,
"applyPayResult": {
"isPaid": true,
"logo": "",
"payData": {
"logo": "",
"expireSeconds": 0,
"payUrl": "",
"payInfo": "",
"wechatPayExtra": {
"appId": "",
"timeStamp": "",
"nonceStr": "",
"package": "",
"signType": "",
"paySign": ""
}
},
"payAccountId": 0,
"walletFlowNo": ""
},
"extraData": {
"giveQuota": 0,
"onlyNewGive": true
}
},
"timestamp": 0,
"traceId": ""
}2.7.10.查询文章
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 查询文章
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
isHidden | boolean | 是否已隐藏 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/essay/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"isHidden": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─title | string | 标题 | - | |
└─mainImg | string | 主图 | - | |
└─url | string | 文章链接 | - | |
└─isHidden | boolean | 是否隐藏 | - | true |
└─appcode | string | 可见应用编码 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"title": "",
"mainImg": "",
"url": "",
"isHidden": true,
"appcode": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}2.7.11.新增文章
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 新增文章
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
title | string | 标题 Validation[Length(max=200, min=0, message=标题长度范围不能超过200个字符)] | true | - | |
mainImg | string | 主图 | true | - | |
url | string | 文章链接 Validation[Length(max=500, min=0, message=文章链接长度不能超过500个字符)] | false | - | |
isHidden | boolean | 是否隐藏 | false | - | true |
appcode | string | 可见应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/essay/add' --data '{
"title": "",
"mainImg": "",
"url": "",
"isHidden": true,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.12.修改文章
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 修改文章
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | 文章id | true | - | 0 |
isHidden | boolean | 是否隐藏，true:下架，false:上架 | true | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/essay/modify' --data '{
"id": 0,
"isHidden": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.13.删除文章
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 删除文章
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | id | true | - | 0 |
appcode | string | 应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/essay/delete' --data '{
"id": 0,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.14.会员配置列表
Type: GET
Author: wangqidong created on 2024/10/10
Content-Type: application/x-www-form-urlencoded
Description: 会员配置列表
Request-example:
curl -X GET -i '/dex/rs/admin/platform/vip/configList'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─level | int32 | 会员等级 | - | 0 |
└─name | string | 等级名称 | - | |
└─icon | string | 等级图标 | - | |
└─color | string | 主题色 | - | |
└─enable | boolean | 是否启用 | - | true |
└─upRule | object | 晋升规则 | - | |
└─or | boolean | true：任一满足，false：全部满足 | - | true |
└─rules | array | 规则 | - | |
└─code | string | 规则编码，curMonthOrderGe：本月单量>=，seriesMonthOrderLt：连续n月订单量<，complaintRateLt：投诉率<，refundRateLt：退款率< | - | |
└─val | number | 值 | - | 0 |
└─seriesMonth | int32 | 连续月份数 | - | 0 |
└─includeCur | boolean | 是否包含本月，默认false | - | true |
└─downRule | object | 降级规则 | - | |
└─or | boolean | true：任一满足，false：全部满足 | - | true |
└─rules | array | 规则 | - | |
└─code | string | 规则编码，curMonthOrderGe：本月单量>=，seriesMonthOrderLt：连续n月订单量<，complaintRateLt：投诉率<，refundRateLt：退款率< | - | |
└─val | number | 值 | - | 0 |
└─seriesMonth | int32 | 连续月份数 | - | 0 |
└─includeCur | boolean | 是否包含本月，默认false | - | true |
└─interests | object | 会员权益 | - | |
└─toneUpCeilingUpRate | number | 下级收益上限上浮比例 | - | 0 |
└─onceWithdrawMaxUpRate | number | 单次最高提现金额上浮比例 | - | 0 |
└─dailyWithdrawMaxUpRate | number | 每日最高提现金额上浮比例 | - | 0 |
└─costPriceDownRate | number | 成本价下浮比例 | - | 0 |
└─priceCeilingUpRate | number | 查询价可修改上限上浮比例 | - | 0 |
└─toneUpCeiling | number | 下级收益上限（实时计算，需指定代理） | - | 0 |
└─onceWithdrawMax | number | 单次最高提现金额（实时计算，需指定代理） | - | 0 |
└─dailyWithdrawMax | number | 每日最高提现金额上浮比例（实时计算，需指定代理） | - | 0 |
└─editable | boolean | 是否允许修改 | - | true |
└─appcode | string | appcode | - | |
└─upMsg | string | 升级提示 | - | |
└─requireReportCount | int32 | 升级所需报告数 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"level": 0,
"name": "",
"icon": "",
"color": "",
"enable": true,
"upRule": {
"or": true,
"rules": [
{
"code": "",
"val": 0,
"seriesMonth": 0,
"includeCur": true
}
]
},
"downRule": {
"or": true,
"rules": [
{
"code": "",
"val": 0,
"seriesMonth": 0,
"includeCur": true
}
]
},
"interests": {
"toneUpCeilingUpRate": 0,
"onceWithdrawMaxUpRate": 0,
"dailyWithdrawMaxUpRate": 0,
"costPriceDownRate": 0,
"priceCeilingUpRate": 0,
"toneUpCeiling": 0,
"onceWithdrawMax": 0,
"dailyWithdrawMax": 0
},
"editable": true,
"appcode": "",
"upMsg": "",
"requireReportCount": 0
}
],
"timestamp": 0,
"traceId": ""
}2.7.15.修改会员规则
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 修改会员规则
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
upRules | array | 升级规则 | false | - | |
└─id | int64 | 会员配置id | true | - | 0 |
└─or | boolean | true：任一满足，false：全部满足，默认false | false | - | true |
└─rules | array | 规则 | false | - | |
└─code | string | 规则编码，curMonthOrderGe：本月单量>=，seriesMonthOrderLt：连续n月订单量<，complaintRateLt：投诉率<，refundRateLt：退款率< | false | - | |
└─val | number | 值 | false | - | 0 |
└─seriesMonth | int32 | 连续月份数 | false | - | 0 |
└─includeCur | boolean | 是否包含本月，默认false | false | - | true |
downRules | array | 降级规则 | false | - | |
└─id | int64 | 会员配置id | true | - | 0 |
└─or | boolean | true：任一满足，false：全部满足，默认false | false | - | true |
└─rules | array | 规则 | false | - | |
└─code | string | 规则编码，curMonthOrderGe：本月单量>=，seriesMonthOrderLt：连续n月订单量<，complaintRateLt：投诉率<，refundRateLt：退款率< | false | - | |
└─val | number | 值 | false | - | 0 |
└─seriesMonth | int32 | 连续月份数 | false | - | 0 |
└─includeCur | boolean | 是否包含本月，默认false | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/vip/editRule' --data '{
"upRules": [
{
"id": 0,
"or": true,
"rules": [
{
"code": "",
"val": 0,
"seriesMonth": 0,
"includeCur": true
}
]
}
],
"downRules": [
{
"id": 0,
"or": true,
"rules": [
{
"code": "",
"val": 0,
"seriesMonth": 0,
"includeCur": true
}
]
}
]
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.7.16.修改会员权益
Type: POST
Author: wangqidong created on 2024/10/10
Content-Type: application/json
Description: 修改会员权益
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
toneUpCeiling | number | 下级收益上限（实时计算，需指定代理） | false | - | 0 |
onceWithdrawMax | number | 单次最高提现金额（实时计算，需指定代理） | false | - | 0 |
dailyWithdrawMax | number | 每日最高提现金额上浮比例（实时计算，需指定代理） | false | - | 0 |
id | int64 | 会员配置id | true | - | 0 |
name | string | 会员名 | false | - | |
toneUpCeilingUpRate | number | 下级收益上限上浮比例 | true | - | 0 |
onceWithdrawMaxUpRate | number | 单次最高提现金额上浮比例 | true | - | 0 |
dailyWithdrawMaxUpRate | number | 每日最高提现金额上浮比例 | true | - | 0 |
costPriceDownRate | number | 成本价下浮比例 | true | - | 0 |
priceCeilingUpRate | number | 查询价可修改上限上浮比例 | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/platform/vip/editInterests' --data '{
"toneUpCeiling": 0,
"onceWithdrawMax": 0,
"dailyWithdrawMax": 0,
"id": 0,
"name": "",
"toneUpCeilingUpRate": 0,
"onceWithdrawMaxUpRate": 0,
"dailyWithdrawMaxUpRate": 0,
"costPriceDownRate": 0,
"priceCeilingUpRate": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}2.8.数据统计
2.8.1.核心指标
Type: GET
Author: wangqidong created on 2024/10/8
Content-Type: application/x-www-form-urlencoded
Description: 核心指标
Request-example:
curl -X GET -i '/dex/rs/admin/statistics/coreStatistics'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─totalOrderCount | int32 | 总订单量 | - | 0 |
└─totalOrderAmount | number | 总营收 | - | 0 |
└─yesOrderCount | int32 | 前一天订单量 | - | 0 |
└─yesOrderAmount | number | 前一天营收 | - | 0 |
└─totalAgentCount | int32 | 总代理数 | - | 0 |
└─yesAgentCount | int32 | 前一天新增代理数 | - | 0 |
└─apiBalance | number | api账户余额 | - | 0 |
└─totalDebt | number | 累计欠款 | - | 0 |
└─totalNotWithdraw | number | 未提现合计 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"totalOrderCount": 0,
"totalOrderAmount": 0,
"yesOrderCount": 0,
"yesOrderAmount": 0,
"totalAgentCount": 0,
"yesAgentCount": 0,
"apiBalance": 0,
"totalDebt": 0,
"totalNotWithdraw": 0
},
"timestamp": 0,
"traceId": ""
}2.8.2.代理成交统计
Type: POST
Author: wangqidong created on 2024/10/8
Content-Type: application/json
Description: 代理成交统计
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
startTime | string | 开始时间 | false | - | yyyy-MM-dd HH:mm:ss |
endTime | string | 结束时间 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/statistics/agentStatistics' --data '{
"startTime": "yyyy-MM-dd HH:mm:ss",
"endTime": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─userId | int64 | 用户id | - | 0 |
└─name | string | 姓名 | - | |
└─mobile | string | 手机号 | - | |
└─orderCount | int64 | 订单数量（产生佣金的订单数量） | - | 0 |
└─orderAmountSum | number | 订单金额（产生佣金的订单金额） | - | 0 |
└─brokerageAmountSum | number | 佣金 | - | 0 |
└─totalBrokerage | number | 累计佣金 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"userId": 0,
"name": "",
"mobile": "",
"orderCount": 0,
"orderAmountSum": 0,
"brokerageAmountSum": 0,
"totalBrokerage": 0
}
],
"timestamp": 0,
"traceId": ""
}2.8.3.模板统计
Type: POST
Author: wangqidong created on 2024/10/8
Content-Type: application/json
Description: 模板统计
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
startTime | string | 开始时间 | false | - | yyyy-MM-dd HH:mm:ss |
endTime | string | 结束时间 | false | - | yyyy-MM-dd HH:mm:ss |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/admin/statistics/templateStatistics' --data '{
"startTime": "yyyy-MM-dd HH:mm:ss",
"endTime": "yyyy-MM-dd HH:mm:ss"
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─orderCount | int32 | 订单数量 | - | 0 |
└─orderAmountSum | number | 订单金额 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"templateCode": "",
"templateName": "",
"orderCount": 0,
"orderAmountSum": 0
}
],
"timestamp": 0,
"traceId": ""
}3.风险检测PC后台
3.1.风险检测模板
3.1.1.模板列表
Type: GET
Author: wangqidong created on 2024/6/25
Content-Type: application/x-www-form-urlencoded
Description: 模板列表
Request-example:
curl -X GET -i '/dex/rs/pc/template/queryList'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─parentTemplateCode | string | 上级模板编码 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
└─upperRoyalty | number | 上级代理分成 | - | 0 |
└─superRoyalty | number | 总代分成 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─brokerageDetail | object | 佣金信息 | - | |
└─userId | int64 | 用户id | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─brokerage | number | 佣金 | - | 0 |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─sort | int32 | No comments found. | - | 0 |
└─subTemplates | array | No comments found. | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"parentTemplateCode": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"superRoyalty": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"brokerageDetail": {
"userId": 0,
"directUserId": 0,
"brokerage": 0
},
"spreadUserId": 0,
"spreadCode": "",
"sort": 0,
"subTemplates": [
{
"$ref": ".."
}
]
}
],
"timestamp": 0,
"traceId": ""
}3.1.2.模板详情
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 模板详情
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/template/queryDetail' --data '{
"templateCode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─ownerUserId | int64 | 模板归属用户ID | - | 0 |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─parentTemplateCode | string | 上级模板编码 | - | |
└─templateSubhead | string | 副标题 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─visibleType | int32 | 可见范围，0-全平台可见，10-租户下可见，100-仅自己可见 | - | 0 |
└─accreditType | int32 | 授权类型，0：无需授权，10：静默授权，20：人脸识别，30：电子签 | - | 0 |
└─backgroundImg | string | 背景图 | - | |
└─themeColors | string | 主题色 | - | |
└─items | array | 模板内容 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
└─isDefault | boolean | 是否默认 | - | true |
└─originPrice | number | 原价 | - | 0 |
└─price | number | 价格 | - | 0 |
└─costPrice | number | 代理成本价 | - | 0 |
└─basePoint | number | 基础成本价加点 | - | 0 |
└─upperRoyalty | number | 上级代理分成 | - | 0 |
└─superRoyalty | number | 总代分成 | - | 0 |
└─priceModifiableCeiling | number | 价格允许修改上限 | - | 0 |
└─suggestSetPrices | array | 建议设置价格 | - | "0,0" |
└─isHot | boolean | 是否热门 | - | true |
└─brokerageDetail | object | 佣金信息 | - | |
└─userId | int64 | 用户id | - | 0 |
└─directUserId | int64 | 订单归属用户id | - | 0 |
└─brokerage | number | 佣金 | - | 0 |
└─spreadUserId | int64 | 推广用户id | - | 0 |
└─spreadCode | string | 推广码 | - | |
└─sort | int32 | No comments found. | - | 0 |
└─subTemplates | array | No comments found. | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"ownerUserId": 0,
"templateCode": "",
"templateName": "",
"parentTemplateCode": "",
"templateSubhead": "",
"surveyType": 0,
"visibleType": 0,
"accreditType": 0,
"backgroundImg": "",
"themeColors": "",
"items": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"isDefault": true,
"originPrice": 0,
"price": 0,
"costPrice": 0,
"basePoint": 0,
"upperRoyalty": 0,
"superRoyalty": 0,
"priceModifiableCeiling": 0,
"suggestSetPrices": [
0
],
"isHot": true,
"brokerageDetail": {
"userId": 0,
"directUserId": 0,
"brokerage": 0
},
"spreadUserId": 0,
"spreadCode": "",
"sort": 0,
"subTemplates": [
{
"$ref": ".."
}
]
},
"timestamp": 0,
"traceId": ""
}3.1.3.查询明细
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 查询明细
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码，不传查询全部 | false | - | |
selectable | boolean | 用户是否可选 | false | - | true |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/template/queryItems' --data '{
"templateCode": "",
"selectable": true
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | array | 响应数据 | - | |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─enable | boolean | 是否启用 | - | true |
└─price | number | 单价 | - | 0 |
└─selectable | boolean | 用户是否可选 | - | true |
└─description | string | 产品描述 | - | |
└─itemIcon | string | 明细项图标 | - | |
└─apiKey | string | apiKey | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": [
{
"itemCode": "",
"itemName": "",
"enable": true,
"price": 0,
"selectable": true,
"description": "",
"itemIcon": "",
"apiKey": ""
}
],
"timestamp": 0,
"traceId": ""
}3.1.4.创建模板
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 创建模板
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 新增不填 编辑必填 | false | - | |
templateName | string | 模板名称 | true | - | |
items | string | 产品编号，逗号隔开 | true | - | |
price | number | 套餐价格 | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/template/create' --data '{
"templateCode": "",
"templateName": "",
"items": "",
"price": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}3.1.5.编辑模板
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 编辑模板
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 新增不填 编辑必填 | false | - | |
templateName | string | 模板名称 | true | - | |
items | string | 产品编号，逗号隔开 | true | - | |
price | number | 套餐价格 | true | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/template/edit' --data '{
"templateCode": "",
"templateName": "",
"items": "",
"price": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}3.1.6.删除模板
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 删除模板
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | 模板编码 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/template/delete' --data '{
"templateCode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}3.2.用户相关
3.2.1.查询登录信息
Type: GET
Author: wangqidong created on 2025/7/11
Content-Type: application/x-www-form-urlencoded
Description: 查询登录信息
Query-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
mustRefresh | boolean | No comments found. | false | - | true |
Request-example:
curl -X GET -i '/dex/rs/pc/user/querySession?mustRefresh=true'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─loginId | string | 登录id | - | |
└─stoken | string | 登录token | - | |
└─userId | int64 | 用户id | - | 0 |
└─username | string | 用户名 | - | |
└─nickname | string | 昵称 | - | |
└─mobile | string | 手机号 | - | |
└─merchantId | int64 | 当前登录的商户id | - | 0 |
└─merchantName | string | 商户名 | - | |
└─enterpriseId | int64 | 企业id | - | 0 |
└─enterpriseName | string | 企业名称 | - | |
└─industry | string | 所属行业 | - | |
└─authType | int32 | 登录用户认证类型，0-未认证，10-个人认证，20-企业认证 | - | 0 |
└─loginAppCode | string | 登录端code | - | |
└─appcode | string | 当前访问端code | - | |
└─appName | string | 当前访问端名称 | - | |
└─bizAppcode | string | 业务应用编码（适用于管理后台访问业务数据） | - | |
└─requestIp | string | 请求ip | - | |
└─agentId | int64 | 当前应用下代理id | - | 0 |
└─salesmanId | int64 | 销售id | - | 0 |
└─assistantId | int64 | 维护人id | - | 0 |
└─tenantId | int64 | 租户id | - | 0 |
└─bizTenantId | int64 | 业务租户id | - | 0 |
└─tenantOwnerId | int64 | 租户所有者用户id | - | 0 |
└─realName | string | 真实姓名 | - | |
└─linkman | string | 联系人（商户） | - | |
└─linkMobile | string | 联系方式（商户） | - | |
string | 邮箱（商户） | - | ||
└─isTemp | boolean | 是否临时登录 | - | true |
└─terminal | enum | 终端类型，android-安卓，ios-ios，harmony-鸿蒙 | - | ANDROID |
└─iv | int32 | 当前内部版本号 | - | 0 |
└─isTest | boolean | 是否测试用户 | - | true |
└─refreshTime | int64 | 刷新时间戳 | - | 0 |
└─staffId | int64 | 员工id | - | 0 |
└─staffName | string | 员工名称 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"loginId": "",
"stoken": "",
"userId": 0,
"username": "",
"nickname": "",
"mobile": "",
"merchantId": 0,
"merchantName": "",
"enterpriseId": 0,
"enterpriseName": "",
"industry": "",
"authType": 0,
"loginAppCode": "",
"appcode": "",
"appName": "",
"bizAppcode": "",
"requestIp": "",
"agentId": 0,
"salesmanId": 0,
"assistantId": 0,
"tenantId": 0,
"bizTenantId": 0,
"tenantOwnerId": 0,
"realName": "",
"linkman": "",
"linkMobile": "",
"email": "",
"isTemp": true,
"terminal": "",
"iv": 0,
"isTest": true,
"refreshTime": 0,
"staffId": 0,
"staffName": ""
},
"timestamp": 0,
"traceId": ""
}3.3.大数据订单
3.3.1.下单配置查询
Type: GET
Author: wangqidong created on 2024/7/20
Content-Type: application/x-www-form-urlencoded
Description: 下单配置查询
Request-example:
curl -X GET -i '/dex/rs/pc/order/querySubmitConfig'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─requireSmsCode | boolean | 是否需要验证码 | - | true |
└─requireAuth | boolean | 是否必须授权 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"requireSmsCode": true,
"requireAuth": true
},
"timestamp": 0,
"traceId": ""
}3.3.2.提交订单
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 提交订单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
name | string | 姓名 | true | - | |
idCard | string | 身份证 | true | - | |
mobile | string | 手机号 | true | - | |
templateCode | string | 报告模板编码 | true | - | |
payMethod | string | 支付方式 | false | - | |
smsCode | string | 短信验证码（短信验证码、人机验证token不能都为空） | false | - | |
captchaToken | string | 人机验证token（短信验证码、人机验证token不能都为空） | false | - | |
authProtocolUrl | string | 授权书链接 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/order/submit' --data '{
"name": "",
"idCard": "",
"mobile": "",
"templateCode": "",
"payMethod": "",
"smsCode": "",
"captchaToken": "",
"authProtocolUrl": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─payType | string | 业务类型，pay-支付，recharge-账户充值，refund-退款 | - | |
└─payMethod | string | 支付方式 | - | |
└─businessType | string | 业务类型（业务方指定） | - | |
└─businessNo | string | 业务单号 | - | |
└─state | int32 | 状态 | - | 0 |
└─feeName | string | 费用项名称 | - | |
└─amount | number | 需支付金额 | - | 0 |
└─applyPayResult | object | 申请支付结果（传递了支付方式会返回） | - | |
└─isPaid | boolean | 是否已支付 | - | true |
└─logo | string | Logo | - | |
└─payData | object | 支付数据 | - | |
└─logo | string | Logo | - | |
└─expireSeconds | int32 | 剩余可支付时间（秒） | - | 0 |
└─payUrl | string | 支付地址 | - | |
└─payInfo | string | 支付信息 | - | |
└─wechatPayExtra | object | 微信支付额外字段 | - | |
└─appId | string | appid | - | |
└─timeStamp | string | 时间戳 | - | |
└─nonceStr | string | 随机字符串 | - | |
└─package | string | 支付地址 | - | |
└─signType | string | 签名类型，默认为RSA，仅支持RSA。 | - | |
└─paySign | string | 签名 | - | |
└─payAccountId | int64 | No comments found. | - | 0 |
└─walletFlowNo | string | 钱包流水编号，钱包支付会记录 | - | |
└─extraData | object | 额外数据 | - | |
└─giveQuota | number | 赠送金额 | - | 0 |
└─onlyNewGive | boolean | 赠送金额是否新客专享 | - | true |
└─orderNo | string | 订单号 | - | |
└─payNo | string | 支付单号 | - | |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─discountTitle | string | 优惠标题 | - | |
└─orderState | int32 | No comments found. | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"payType": "",
"payMethod": "",
"businessType": "",
"businessNo": "",
"state": 0,
"feeName": "",
"amount": 0,
"applyPayResult": {
"isPaid": true,
"logo": "",
"payData": {
"logo": "",
"expireSeconds": 0,
"payUrl": "",
"payInfo": "",
"wechatPayExtra": {
"appId": "",
"timeStamp": "",
"nonceStr": "",
"package": "",
"signType": "",
"paySign": ""
}
},
"payAccountId": 0,
"walletFlowNo": ""
},
"extraData": {
"giveQuota": 0,
"onlyNewGive": true
},
"orderNo": "",
"payNo": "",
"originAmount": 0,
"orderAmount": 0,
"discountTitle": "",
"orderState": 0
},
"timestamp": 0,
"traceId": ""
}3.3.3.查询报告
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 查询报告
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | false | - | |
shareCode | string | 分享码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/order/queryReport' --data '{
"orderNo": "",
"shareCode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─orderNo | string | 订单编号 | - | |
└─isFinished | boolean | 报告是否完成 | - | true |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─createTime | string | 下单时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 报告生成时间 | - | yyyy-MM-dd HH:mm:ss |
└─reportLevel | string | 风险指数 | - | |
└─riskScore | int32 | 风险分 | - | 0 |
└─reportIndexes | array | 报告指标 | - | |
└─code | string | 指标编码 | - | |
└─name | string | 指标名称 | - | |
└─value | string | 指标值 | - | |
└─valueExplain | string | value说明 | - | |
└─valueRangeMin | string | 最小值 | - | |
└─valueRangeMax | string | 最小值 | - | |
└─description | string | 说明 | - | |
└─riskLevel | string | 风险度，low，mid，high | - | |
└─riskColor | string | 颜色 | - | |
└─reportIssues | array | 风险点概览 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─icon | string | 图标 | - | |
└─issues | array | 风险点 | - | """,""" |
└─personalInfo | object | 个人信息 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─gender | string | 性别 | - | |
└─age | int32 | 年龄 | - | 0 |
└─registerResidenceAddress | string | 户籍地 | - | |
└─realNamePass | boolean | 实名认证是否通过 | - | true |
└─constellation | string | 星座 | - | |
└─marriageStatus | string | 婚姻状态 | - | |
└─mobileInfo | object | 手机号信息 | - | |
└─mobile | string | 手机号 | - | |
└─mobileTriplePass | boolean | 手机号身份证姓名一致性校验结果 | - | true |
└─operatorType | string | 运营商类型，1：移动，2：联通，3：电信 | - | |
└─onlineDuration | string | 在网时长，A：[0,3) B：[3,6) C：[6,12) D：[12,24) E：[24-36)，移动为[24,+) F：[36,+)，单位：月，移动不反馈 | - | |
└─onlineStatus | string | 在网状态 | - | |
└─belongLocation | string | 归属地 | - | |
└─suspectedCard | boolean | 是否疑似养卡 | - | true |
└─courtSummary | object | 司法风险概述 | - | |
└─zhixing | boolean | 被执行人：true/false | - | true |
└─xiangao | boolean | 限制高消费 true/false | - | true |
└─shean | boolean | 涉案人员 true/false | - | true |
└─beigao | boolean | 被告人员 true/false | - | true |
└─beigaowei | boolean | 被告未结案人员 true/false | - | true |
└─xingshi | boolean | 是否命中刑事案件 true/false | - | true |
└─beigaoweimoney | string | 被告未结案金额（等级） | - | |
└─beigaoweimoneyDesc | string | 被告未结案金额区间（万元），这个字段直接展示 | - | |
└─loanSummary | object | 借贷风险概述（全景雷达产品返回，其他东西不要往这里面加） | - | |
└─shenqingzhunru | int32 | 申请准入分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─zhixindu | int32 | 置信度评分50-100，[50-60]-红色、(60,80]-橙色、(80,100]-绿色 | - | 0 |
└─xingweifen | int32 | 贷款行为分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─chaxunzongcishu | string | 机构查询总次数 | - | |
└─zhengchangbili | string | 正常还款订单数占贷款总订单数比例 | - | |
└─yijieqingcount | string | 已结清订单数 | - | |
└─shouxinedu | string | 预估网贷授信额度 | - | |
└─jiekuanmoneyzong | string | 借款总金额（2 年内） | - | |
└─jiekuancount | string | 借贷机构数（2 年内） | - | |
└─debtamount | string | 逾期总金额（2 年内） | - | |
└─wangdaicahnpincount | string | 网贷产品数 | - | |
└─reportItems | array | 报告明细 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─notes | string | 说明 | - | |
└─icon | string | 图标 | - | |
└─sv | string | 策略版本号 | - | |
└─reportUrl | string | 子项报告链接 | - | |
└─result | object | 结果 | - | |
└─sort | int32 | 排序 | - | 0 |
└─customData | object | 定制内容 | - | |
└─reportUrl | string | 报告地址 | - | |
└─allowShare | boolean | 报告是否允许分享 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"orderNo": "",
"isFinished": true,
"name": "",
"idCard": "",
"mobile": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"reportLevel": "",
"riskScore": 0,
"reportIndexes": [
{
"code": "",
"name": "",
"value": "",
"valueExplain": "",
"valueRangeMin": "",
"valueRangeMax": "",
"description": "",
"riskLevel": "",
"riskColor": ""
}
],
"reportIssues": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"icon": "",
"issues": [
""
]
}
],
"personalInfo": {
"name": "",
"idCard": "",
"mobile": "",
"gender": "",
"age": 0,
"registerResidenceAddress": "",
"realNamePass": true,
"constellation": "",
"marriageStatus": ""
},
"mobileInfo": {
"mobile": "",
"mobileTriplePass": true,
"operatorType": "",
"onlineDuration": "",
"onlineStatus": "",
"belongLocation": "",
"suspectedCard": true
},
"courtSummary": {
"zhixing": true,
"xiangao": true,
"shean": true,
"beigao": true,
"beigaowei": true,
"xingshi": true,
"beigaoweimoney": "",
"beigaoweimoneyDesc": ""
},
"loanSummary": {
"shenqingzhunru": 0,
"zhixindu": 0,
"xingweifen": 0,
"chaxunzongcishu": "",
"zhengchangbili": "",
"yijieqingcount": "",
"shouxinedu": "",
"jiekuanmoneyzong": "",
"jiekuancount": "",
"debtamount": "",
"wangdaicahnpincount": ""
},
"reportItems": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"notes": "",
"icon": "",
"sv": "",
"reportUrl": "",
"result": {},
"sort": 0
}
],
"customData": {
"object": "any object"
},
"reportUrl": "",
"allowShare": true
},
"timestamp": 0,
"traceId": ""
}3.3.4.报告示例
Type: GET
Author: wangqidong created on 2024/7/20
Content-Type: application/x-www-form-urlencoded
Description: 报告示例
Query-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
templateCode | string | No comments found. | false | - |
Request-example:
curl -X GET -i '/dex/rs/pc/order/queryExampleReport?templateCode='Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─orderNo | string | 订单编号 | - | |
└─isFinished | boolean | 报告是否完成 | - | true |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─createTime | string | 下单时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 报告生成时间 | - | yyyy-MM-dd HH:mm:ss |
└─reportLevel | string | 风险指数 | - | |
└─riskScore | int32 | 风险分 | - | 0 |
└─reportIndexes | array | 报告指标 | - | |
└─code | string | 指标编码 | - | |
└─name | string | 指标名称 | - | |
└─value | string | 指标值 | - | |
└─valueExplain | string | value说明 | - | |
└─valueRangeMin | string | 最小值 | - | |
└─valueRangeMax | string | 最小值 | - | |
└─description | string | 说明 | - | |
└─riskLevel | string | 风险度，low，mid，high | - | |
└─riskColor | string | 颜色 | - | |
└─reportIssues | array | 风险点概览 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─icon | string | 图标 | - | |
└─issues | array | 风险点 | - | """,""" |
└─personalInfo | object | 个人信息 | - | |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─gender | string | 性别 | - | |
└─age | int32 | 年龄 | - | 0 |
└─registerResidenceAddress | string | 户籍地 | - | |
└─realNamePass | boolean | 实名认证是否通过 | - | true |
└─constellation | string | 星座 | - | |
└─marriageStatus | string | 婚姻状态 | - | |
└─mobileInfo | object | 手机号信息 | - | |
└─mobile | string | 手机号 | - | |
└─mobileTriplePass | boolean | 手机号身份证姓名一致性校验结果 | - | true |
└─operatorType | string | 运营商类型，1：移动，2：联通，3：电信 | - | |
└─onlineDuration | string | 在网时长，A：[0,3) B：[3,6) C：[6,12) D：[12,24) E：[24-36)，移动为[24,+) F：[36,+)，单位：月，移动不反馈 | - | |
└─onlineStatus | string | 在网状态 | - | |
└─belongLocation | string | 归属地 | - | |
└─suspectedCard | boolean | 是否疑似养卡 | - | true |
└─courtSummary | object | 司法风险概述 | - | |
└─zhixing | boolean | 被执行人：true/false | - | true |
└─xiangao | boolean | 限制高消费 true/false | - | true |
└─shean | boolean | 涉案人员 true/false | - | true |
└─beigao | boolean | 被告人员 true/false | - | true |
└─beigaowei | boolean | 被告未结案人员 true/false | - | true |
└─xingshi | boolean | 是否命中刑事案件 true/false | - | true |
└─beigaoweimoney | string | 被告未结案金额（等级） | - | |
└─beigaoweimoneyDesc | string | 被告未结案金额区间（万元），这个字段直接展示 | - | |
└─loanSummary | object | 借贷风险概述（全景雷达产品返回，其他东西不要往这里面加） | - | |
└─shenqingzhunru | int32 | 申请准入分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─zhixindu | int32 | 置信度评分50-100，[50-60]-红色、(60,80]-橙色、(80,100]-绿色 | - | 0 |
└─xingweifen | int32 | 贷款行为分0-1000，[0,500]-红色、(500,600]-橙色、(600,1000]-绿色 | - | 0 |
└─chaxunzongcishu | string | 机构查询总次数 | - | |
└─zhengchangbili | string | 正常还款订单数占贷款总订单数比例 | - | |
└─yijieqingcount | string | 已结清订单数 | - | |
└─shouxinedu | string | 预估网贷授信额度 | - | |
└─jiekuanmoneyzong | string | 借款总金额（2 年内） | - | |
└─jiekuancount | string | 借贷机构数（2 年内） | - | |
└─debtamount | string | 逾期总金额（2 年内） | - | |
└─wangdaicahnpincount | string | 网贷产品数 | - | |
└─reportItems | array | 报告明细 | - | |
└─itemId | int64 | 明细id | - | 0 |
└─itemCode | string | 明细项编码 | - | |
└─itemName | string | 明细项名称 | - | |
└─notes | string | 说明 | - | |
└─icon | string | 图标 | - | |
└─sv | string | 策略版本号 | - | |
└─reportUrl | string | 子项报告链接 | - | |
└─result | object | 结果 | - | |
└─sort | int32 | 排序 | - | 0 |
└─customData | object | 定制内容 | - | |
└─reportUrl | string | 报告地址 | - | |
└─allowShare | boolean | 报告是否允许分享 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"orderNo": "",
"isFinished": true,
"name": "",
"idCard": "",
"mobile": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"reportLevel": "",
"riskScore": 0,
"reportIndexes": [
{
"code": "",
"name": "",
"value": "",
"valueExplain": "",
"valueRangeMin": "",
"valueRangeMax": "",
"description": "",
"riskLevel": "",
"riskColor": ""
}
],
"reportIssues": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"icon": "",
"issues": [
""
]
}
],
"personalInfo": {
"name": "",
"idCard": "",
"mobile": "",
"gender": "",
"age": 0,
"registerResidenceAddress": "",
"realNamePass": true,
"constellation": "",
"marriageStatus": ""
},
"mobileInfo": {
"mobile": "",
"mobileTriplePass": true,
"operatorType": "",
"onlineDuration": "",
"onlineStatus": "",
"belongLocation": "",
"suspectedCard": true
},
"courtSummary": {
"zhixing": true,
"xiangao": true,
"shean": true,
"beigao": true,
"beigaowei": true,
"xingshi": true,
"beigaoweimoney": "",
"beigaoweimoneyDesc": ""
},
"loanSummary": {
"shenqingzhunru": 0,
"zhixindu": 0,
"xingweifen": 0,
"chaxunzongcishu": "",
"zhengchangbili": "",
"yijieqingcount": "",
"shouxinedu": "",
"jiekuanmoneyzong": "",
"jiekuancount": "",
"debtamount": "",
"wangdaicahnpincount": ""
},
"reportItems": [
{
"itemId": 0,
"itemCode": "",
"itemName": "",
"notes": "",
"icon": "",
"sv": "",
"reportUrl": "",
"result": {},
"sort": 0
}
],
"customData": {
"object": "any object"
},
"reportUrl": "",
"allowShare": true
},
"timestamp": 0,
"traceId": ""
}3.3.5.订单列表
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 订单列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
submitType | int32 | 下单方式，10-直查，20-扫码查询 | false | - | 0 |
keyword | string | 搜索关键字 | false | - | |
stateList | array | 订单状态 | false | - | "0,0" |
payStateList | array | 支付状态 | false | - | "0,0" |
name | string | 姓名全匹配 | false | - | |
mobile | string | 手机号 | false | - | |
templateCode | string | 模板编码 | false | - | |
payMethod | string | 支付方式 | false | - | |
finishTimeGte | string | 实际完成时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
finishTimeLte | string | 实际完成时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeGte | string | 创建时间大于 | false | - | yyyy-MM-dd HH:mm:ss |
createTimeLte | string | 创建时间小于 | false | - | yyyy-MM-dd HH:mm:ss |
createBy | int64 | 创建人id | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/order/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"submitType": 0,
"keyword": "",
"stateList": [
0
],
"payStateList": [
0
],
"name": "",
"mobile": "",
"templateCode": "",
"payMethod": "",
"finishTimeGte": "yyyy-MM-dd HH:mm:ss",
"finishTimeLte": "yyyy-MM-dd HH:mm:ss",
"createTimeGte": "yyyy-MM-dd HH:mm:ss",
"createTimeLte": "yyyy-MM-dd HH:mm:ss",
"createBy": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─orderNo | string | 订单编号 | - | |
└─userId | int64 | 用户id | - | 0 |
└─userName | string | 用户名 | - | |
└─submitType | int32 | 下单方式，10-直查，20-扫码查询 | - | 0 |
└─state | int32 | 订单状态，10-待支付，50-进行中，,100-已完成 | - | 0 |
└─payState | int32 | 支付状态 | - | 0 |
└─name | string | 姓名 | - | |
└─idCard | string | 身份证号码 | - | |
└─mobile | string | 手机号 | - | |
└─plateNumber | string | 车牌号 | - | |
└─vin | string | 车架号 | - | |
└─templateCode | string | 模板编码 | - | |
└─templateName | string | 模板名称 | - | |
└─surveyType | int32 | 调查类型，10-个人，20-企业 | - | 0 |
└─originAmount | number | 原金额 | - | 0 |
└─orderAmount | number | 订单金额 | - | 0 |
└─paidAmount | number | 实付金额 | - | 0 |
└─refundAmount | number | 订单已退款金额 | - | 0 |
└─payMethod | string | 支付方式 | - | |
└─payTime | string | 支付时间 | - | yyyy-MM-dd HH:mm:ss |
└─finishTime | string | 实际完成时间 | - | yyyy-MM-dd HH:mm:ss |
└─refundTime | string | 退款时间 | - | yyyy-MM-dd HH:mm:ss |
└─brokerageAmount | number | 佣金 | - | 0 |
└─disputeType | string | 订单争议类型 | - | |
└─payNo | string | 支付单号 | - | |
└─reportLevel | string | 风险等级 | - | |
└─operatorName | string | 操作员名称 | - | |
└─seqNo | string | 流水号 | - | |
└─reportViewable | boolean | 是否可查看报告 | - | true |
└─appcode | string | appcode | - | |
└─bits | int64 | 位标 | - | 0 |
└─reportUrl | string | 报告地址 | - | |
└─shareCode | string | No comments found. | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"orderNo": "",
"userId": 0,
"userName": "",
"submitType": 0,
"state": 0,
"payState": 0,
"name": "",
"idCard": "",
"mobile": "",
"plateNumber": "",
"vin": "",
"templateCode": "",
"templateName": "",
"surveyType": 0,
"originAmount": 0,
"orderAmount": 0,
"paidAmount": 0,
"refundAmount": 0,
"payMethod": "",
"payTime": "yyyy-MM-dd HH:mm:ss",
"finishTime": "yyyy-MM-dd HH:mm:ss",
"refundTime": "yyyy-MM-dd HH:mm:ss",
"brokerageAmount": 0,
"disputeType": "",
"payNo": "",
"reportLevel": "",
"operatorName": "",
"seqNo": "",
"reportViewable": true,
"appcode": "",
"bits": 0,
"reportUrl": "",
"shareCode": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}3.3.6.删除订单
Type: POST
Author: wangqidong created on 2024/7/20
Content-Type: application/json
Description: 删除订单
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
orderNo | string | 订单号 | true | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/order/delete' --data '{
"orderNo": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}3.4.首页数据
3.4.1.数据统计
Type: POST
Author: wangqidong created on 2024/6/25
Content-Type: application/json
Description: 数据统计
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
startTime | string | No comments found. | true | - | yyyy-MM-dd HH:mm:ss |
endTime | string | No comments found. | true | - | yyyy-MM-dd HH:mm:ss |
userId | int64 | No comments found. | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/index/statistics' --data '{
"startTime": "yyyy-MM-dd HH:mm:ss",
"endTime": "yyyy-MM-dd HH:mm:ss",
"userId": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─dateOrderStatistics | array | 日期订单统计 | - | |
└─date | string | 日期 | - | |
└─dateCount | int32 | 订单数量 | - | 0 |
└─dateMoney | number | No comments found. | - | 0 |
└─riskLevelStatistics | array | 风险等级统计 | - | |
└─reportLevel | string | 报告等级 A 无风险 B 未知风险 C 中低风险 D 中风险 E 中高风险 F 高风险 | - | |
└─count | int32 | 对应数量 | - | 0 |
└─totalCount | int32 | 订单数量 | - | 0 |
└─totalMoney | number | 订单金额 | - | 0 |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"dateOrderStatistics": [
{
"date": "",
"dateCount": 0,
"dateMoney": 0
}
],
"riskLevelStatistics": [
{
"reportLevel": "",
"count": 0
}
],
"totalCount": 0,
"totalMoney": 0
},
"timestamp": 0,
"traceId": ""
}3.5.员工管理
3.5.1.员工列表
Type: POST
Author: wangqidong created on 2024/9/4
Content-Type: application/json
Description: 员工列表
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
pageNo | int32 | 页码，从1开始 | false | - | 0 |
pageSize | int32 | 每页条数 | false | - | 0 |
nonPage | boolean | 是否不分页，nonPage和largePage都为true时优先nonPage | false | - | true |
largePage | boolean | 是否大数据量分页，nonPage和largePage都为true时优先nonPage | false | - | true |
keyword | string | 关键字搜索 | false | - | |
merchantId | int64 | No comments found. | false | - | 0 |
appcode | string | No comments found. | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/staff/list' --data '{
"pageNo": 0,
"pageSize": 0,
"nonPage": true,
"largePage": true,
"keyword": "",
"merchantId": 0,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─pageNo | int32 | 页码，从1开始 | - | 0 |
└─pageSize | int32 | 每页条数 | - | 0 |
└─hasNext | boolean | 是否还有下一页 | - | true |
└─total | int64 | 总条数 | - | 0 |
└─results | array | 当前页结果 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─departmentId | int64 | 部门id | - | 0 |
└─userId | int64 | 用户id | - | 0 |
└─name | string | 真实姓名 | - | |
└─nickname | string | 昵称 | - | |
└─mobile | string | 手机号 | - | |
string | 邮箱 | - | ||
└─maxWalletQuota | number | 钱包调用限额 | - | 0 |
└─usedWalletQuota | number | 已使用限额 | - | 0 |
└─remark | string | 备注 | - | |
└─isLarge | boolean | 是否大数据分页 | - | true |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"pageNo": 0,
"pageSize": 0,
"hasNext": true,
"total": 0,
"results": [
{
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"departmentId": 0,
"userId": 0,
"name": "",
"nickname": "",
"mobile": "",
"email": "",
"maxWalletQuota": 0,
"usedWalletQuota": 0,
"remark": ""
}
],
"isLarge": true
},
"timestamp": 0,
"traceId": ""
}3.5.2.添加员工
Type: POST
Author: wangqidong created on 2024/9/4
Content-Type: application/json
Description: 添加员工
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | 员工id | false | - | 0 |
departmentId | int64 | 部门id | false | - | 0 |
name | string | 真实姓名 | false | - | |
mobile | string | 手机号 | false | - | |
string | 邮箱 | false | - | ||
remark | string | 备注 | false | - | |
maxWalletQuota | number | 钱包调用限额 | false | - | 0 |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/staff/save' --data '{
"id": 0,
"departmentId": 0,
"name": "",
"mobile": "",
"email": "",
"remark": "",
"maxWalletQuota": 0
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"timestamp": 0,
"traceId": ""
}3.5.3.员工详情
Type: GET
Author: wangqidong created on 2024/9/4
Content-Type: application/x-www-form-urlencoded
Description: 员工详情
Path-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | No comments found. | true | - | 0 |
Request-example:
curl -X GET -i '/dex/rs/pc/staff/detail/{id}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | object | 响应数据 | - | |
└─id | int64 | 主键 | - | 0 |
└─createBy | int64 | 创建人id | - | 0 |
└─createTime | string | 创建时间 | - | yyyy-MM-dd HH:mm:ss |
└─modifyTime | string | 修改时间 | - | yyyy-MM-dd HH:mm:ss |
└─departmentId | int64 | 部门id | - | 0 |
└─userId | int64 | 用户id | - | 0 |
└─name | string | 真实姓名 | - | |
└─nickname | string | 昵称 | - | |
└─mobile | string | 手机号 | - | |
string | 邮箱 | - | ||
└─maxWalletQuota | number | 钱包调用限额 | - | 0 |
└─usedWalletQuota | number | 已使用限额 | - | 0 |
└─remark | string | 备注 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": {
"id": 0,
"createBy": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"modifyTime": "yyyy-MM-dd HH:mm:ss",
"departmentId": 0,
"userId": 0,
"name": "",
"nickname": "",
"mobile": "",
"email": "",
"maxWalletQuota": 0,
"usedWalletQuota": 0,
"remark": ""
},
"timestamp": 0,
"traceId": ""
}3.5.4.删除员工
Type: POST
Author: wangqidong created on 2024/9/4
Content-Type: application/json
Description: 删除员工
Body-parameters:
| Parameter | Type | Description | Required | Since | Example |
|---|---|---|---|---|---|
id | int64 | id | true | - | 0 |
appcode | string | 应用编码 | false | - |
Request-example:
curl -X POST -H "Content-Type: application/json" -i '/dex/rs/pc/staff/delete' --data '{
"id": 0,
"appcode": ""
}'Response-fields:
| Field | Type | Description | Since | Example |
|---|---|---|---|---|
code | int32 | 响应码，0-成功 | - | 0 |
msg | string | 响应提示 | - | |
data | int64 | 响应数据 | - | |
timestamp | int64 | 时间戳 | - | 0 |
traceId | string | 请求链路id | - |
Response-example:
{
"code": 0,
"msg": "",
"data": 0,
"timestamp": 0,
"traceId": ""
}
Top