Version Update Time Status Author Description

v2025-10-31 16:20:51

2025-10-31 16:20:51

auto

@root

Created by smart-doc

1.default

1.1.爱签回调

1.1.1.签署结果

Type: POST

Author: wangqidong created on 2025/3/24

Content-Type: application/x-www-form-urlencoded;multipart/form-data

Description: 签署结果

Path-parameters:

Parameter Type Description Required Since Example

type

string

No comments found.

true

-

Body-parameters:

Parameter Type Description Required Since Example

account

string

No comments found.

false

-

action

string

No comments found.

false

-

contractNo

string

No comments found.

false

-

status

int32

状态 0：等待签约 1：签约中 2：已签约 3：过期 4：拒签 6：作废 7：撤销

false

-

0

signTime

string

签署时间

false

-

timestamp

int64

No comments found.

false

-

0

validityTime

string

No comments found.

false

-

signMark

string

No comments found.

false

-

sign

string

No comments found.

false

-

remark

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/x-www-form-urlencoded;multipart/form-data" -i '/subgrade/notify/asign/signResult/{type}' --data 'validityTime=""&status=0&action=""&signTime=""&account=""&remark=""&contractNo=""&sign=""&signMark=""×tamp=0'

Response-example:

string

1.2.BeeOpenApiController

1.2.1.拉取活体验证结果

Type: POST

Author: wangqidong created on 2025/5/22

Content-Type: application/json

Description: 拉取活体验证结果

Body-parameters:

Parameter Type Description Required Since Example

seqNo

string

流水号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/open/bee/queryH5LiveH2Result' --data '{
  "seqNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─status

int32

结果，-1：认证失败，0：未查询到活体检测结果，1：认证通过，2：认证不通过，3：疑似同一人，4：活体检测不通过

-

0

└─score

number

比较结果分值，人像分数范围0~1000，同一人：分数>700；非同一人：分数≤600；疑似为同一人：600<分数≤700

-

0

└─returnUrl

string

认证通过页面回跳地址

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "status": 0,
    "score": 0,
    "returnUrl": ""
  },
  "timestamp": 0,
  "traceId": ""
}

2.账户体系

2.1.用户管理

2.1.1.添加用户

Type: POST

Author: wangqidong created on 2024/8/2

Content-Type: application/json

Description: 添加用户

Body-parameters:

Parameter Type Description Required Since Example

username

string

用户名

true

-

nickname

string

昵称

false

-

mobile

string

手机号

true

-

authType

int32

认证类型，0-未认证，10-个人认证，20-企业认证，不传默认未认证

false

-

0

realName

string

真实姓名

false

-

idCard

string

身份证号码

false

-

portrait

string

头像

false

-

email

string

邮箱

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

tenantId

int64

所属租户id，不穿默认：1

false

-

0

appcodes

array

可用系统

true

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/manage/user/addUser' --data '{
  "username": "",
  "nickname": "",
  "mobile": "",
  "authType": 0,
  "realName": "",
  "idCard": "",
  "portrait": "",
  "email": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  },
  "tenantId": 0,
  "appcodes": [
    ""
  ]
}'

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

└─username

string

用户名

-

└─organizationName

string

组织名

-

└─nickname

string

昵称

-

└─mobile

string

手机号

-

└─wechatOpenid

string

微信openid

-

└─state

int32

用户状态，0:初始状态，-1:已注销，10-正常

-

0

└─authType

int32

认证类型，0-未认证，10-个人认证，20-企业认证

-

0

└─authTime

string

认证时间

-

yyyy-MM-dd HH:mm:ss

└─idCard

string

身份证号码

-

└─portrait

string

头像

-

└─realName

string

真实姓名

-

└─email

string

邮箱

-

└─wechatNo

string

微信号

-

└─wechatNickname

string

微信昵称

-

└─sourceAppcode

string

注册系统编码

-

└─sourceDesc

string

用户来源

-

└─sourceType

string

用户来源

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─linkAddress

object

联系地址

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─invitationCode

string

邀请码

-

└─isTest

boolean

是否测试用户

-

true

└─tenantId

int64

所属租户id

-

0

└─roleList

array

权限

-

""","""

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",
    "username": "",
    "organizationName": "",
    "nickname": "",
    "mobile": "",
    "wechatOpenid": "",
    "state": 0,
    "authType": 0,
    "authTime": "yyyy-MM-dd HH:mm:ss",
    "idCard": "",
    "portrait": "",
    "realName": "",
    "email": "",
    "wechatNo": "",
    "wechatNickname": "",
    "sourceAppcode": "",
    "sourceDesc": "",
    "sourceType": "",
    "linkman": "",
    "linkMobile": "",
    "linkAddress": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "invitationCode": "",
    "isTest": true,
    "tenantId": 0,
    "roleList": [
      ""
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.用户相关

2.2.1.登录

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 登录

Body-parameters:

Parameter Type Description Required Since Example

loginType

string

登录类型，password:账号密码登录，sms:手机验证码登录，wechatMp: 公众号授权登录，oneKey: 一键登录

true

-

loginKey

string

登录key，用户名密码登录为用户名，手机验证码登录为手机号，一键登录为认证token

true

-

password

string

密码（md5）

false

-

smsCode

string

短信验证码

false

-

registerIfAbsent

boolean

如果用户不存在，是否一键注册

false

-

true

wechatOpenid

string

微信openid

false

-

reregister

boolean

确认重新注册

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/login' --data '{
  "loginType": "",
  "loginKey": "",
  "password": "",
  "smsCode": "",
  "registerIfAbsent": true,
  "wechatOpenid": "",
  "reregister": 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

昵称

-

└─showName

string

展示名称

-

└─mobile

string

手机号

-

└─portrait

string

头像

-

└─email

string

邮箱

-

└─roles

array

角色

-

""","""

└─authType

int32

登录用户认证类型，0-未认证，10-个人认证，20-企业认证

-

0

└─loginAppCode

string

登录端code

-

└─currentAppcode

string

当前访问端code

-

└─currentAppName

string

当前访问端code

-

└─bizAppcode

string

业务应用编码（适用于管理后台访问业务数据）

-

└─requestIp

string

请求ip

-

└─merchantId

int64

当前登录的商户id

-

0

└─merchantName

string

登录商户名称

-

└─tenantId

int64

租户id

-

0

└─registerTime

string

注册时间

-

yyyy-MM-dd HH:mm:ss

└─realName

string

真实姓名

-

└─comRoute

string

首页路由（仅登录接口会返回）

-

└─routeUrl

string

首页路由（仅登录接口会返回）

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─industry

string

所属行业

-

└─visibleAppcodes

array

可访问的应用编码

-

""","""

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "loginId": "",
    "stoken": "",
    "userId": 0,
    "username": "",
    "nickname": "",
    "showName": "",
    "mobile": "",
    "portrait": "",
    "email": "",
    "roles": [
      ""
    ],
    "authType": 0,
    "loginAppCode": "",
    "currentAppcode": "",
    "currentAppName": "",
    "bizAppcode": "",
    "requestIp": "",
    "merchantId": 0,
    "merchantName": "",
    "tenantId": 0,
    "registerTime": "yyyy-MM-dd HH:mm:ss",
    "realName": "",
    "comRoute": "",
    "routeUrl": "",
    "linkman": "",
    "linkMobile": "",
    "industry": "",
    "visibleAppcodes": [
      ""
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.2.访客登录

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 访客登录

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

手机号 Validation[Pattern(regexp=1[3-9]\d{9}, message=手机号格式错误)]

true

-

smsCode

string

验证码 Validation[Pattern(regexp=\d{4,6}, message=验证码输入错误)]

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/visitorLogin' --data '{
  "mobile": "",
  "smsCode": ""
}'

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

联系方式（商户）

-

└─email

string

邮箱（商户）

-

└─isTemp

boolean

是否临时登录

-

true

└─terminal

enum

终端类型，android-安卓，ios-ios，harmony-鸿蒙
(See: 应用终端类型)

-

ANDROID

└─iv

int32

当前内部版本号

-

0

└─isTest

boolean

是否测试用户

-

true

└─refreshTime

int64

刷新时间戳

-

0

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
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.3.用户登出

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/x-www-form-urlencoded

Description: 用户登出

Request-example:

curl -X POST -i '/subgrade/account/user/logout'

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: GET

Author: wangqidong created on 2024/5/20

Content-Type: application/x-www-form-urlencoded

Description: 查询登录信息

Query-parameters:

Parameter Type Description Required Since Example

stoken

string

No comments found.

false

-

Request-example:

curl -X GET -i '/subgrade/account/user/querySession?stoken='

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

昵称

-

└─showName

string

展示名称

-

└─mobile

string

手机号

-

└─portrait

string

头像

-

└─email

string

邮箱

-

└─roles

array

角色

-

""","""

└─authType

int32

登录用户认证类型，0-未认证，10-个人认证，20-企业认证

-

0

└─loginAppCode

string

登录端code

-

└─currentAppcode

string

当前访问端code

-

└─currentAppName

string

当前访问端code

-

└─bizAppcode

string

业务应用编码（适用于管理后台访问业务数据）

-

└─requestIp

string

请求ip

-

└─merchantId

int64

当前登录的商户id

-

0

└─merchantName

string

登录商户名称

-

└─tenantId

int64

租户id

-

0

└─registerTime

string

注册时间

-

yyyy-MM-dd HH:mm:ss

└─realName

string

真实姓名

-

└─comRoute

string

首页路由（仅登录接口会返回）

-

└─routeUrl

string

首页路由（仅登录接口会返回）

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─industry

string

所属行业

-

└─visibleAppcodes

array

可访问的应用编码

-

""","""

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "loginId": "",
    "stoken": "",
    "userId": 0,
    "username": "",
    "nickname": "",
    "showName": "",
    "mobile": "",
    "portrait": "",
    "email": "",
    "roles": [
      ""
    ],
    "authType": 0,
    "loginAppCode": "",
    "currentAppcode": "",
    "currentAppName": "",
    "bizAppcode": "",
    "requestIp": "",
    "merchantId": 0,
    "merchantName": "",
    "tenantId": 0,
    "registerTime": "yyyy-MM-dd HH:mm:ss",
    "realName": "",
    "comRoute": "",
    "routeUrl": "",
    "linkman": "",
    "linkMobile": "",
    "industry": "",
    "visibleAppcodes": [
      ""
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.5.修改密码

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 修改密码

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

手机号

true

-

smsCode

string

短信验证码

true

-

password

string

密码（MD5）

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/resetPassword' --data '{
  "mobile": "",
  "smsCode": "",
  "password": ""
}'

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/5/20

Content-Type: application/json

Description: 新老手机号两步认证都调用这个接口

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

手机号

true

-

smsCode

string

短信验证码

true

-

verifyOrigin

boolean

是否为认证原手机号

true

-

true

originVerifyToken

string

原手机号认证通过返回的认证token

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/changeMobile' --data '{
  "mobile": "",
  "smsCode": "",
  "verifyOrigin": true,
  "originVerifyToken": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─originVerifyToken

string

原手机号认证通过返回的认证token

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "originVerifyToken": ""
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.7.绑定手机号（不验证原手机号）

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 绑定手机号（不验证原手机号）

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

手机号

true

-

smsCode

string

短信验证码

true

-

bindScene

int32

绑定场景，

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/bindMobile' --data '{
  "mobile": "",
  "smsCode": "",
  "bindScene": 0
}'

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

联系方式（商户）

-

└─email

string

邮箱（商户）

-

└─isTemp

boolean

是否临时登录

-

true

└─terminal

enum

终端类型，android-安卓，ios-ios，harmony-鸿蒙
(See: 应用终端类型)

-

ANDROID

└─iv

int32

当前内部版本号

-

0

└─isTest

boolean

是否测试用户

-

true

└─refreshTime

int64

刷新时间戳

-

0

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
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.8.绑定邮箱

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 绑定邮箱

Body-parameters:

Parameter Type Description Required Since Example

email

string

手机号

true

-

smsCode

string

短信验证码

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/bindEmail' --data '{
  "email": "",
  "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.2.9.关联用户列表

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 关联用户列表

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

用户 id

false

-

0

requireLogin

boolean

是否需要登录

false

-

true

relatedTypeList

array

No comments found.

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/relatedList' --data '{
  "userId": 0,
  "requireLogin": true,
  "relatedTypeList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─relatedId

int64

No comments found.

-

0

└─relatedUserId

int64

关联的用户id

-

0

└─relatedName

string

关联的用户名称

-

└─mobile

string

手机号

-

└─relatedType

string

关联类型

-

└─usableAppcodes

array

可用系统编码

-

""","""

└─appcode

string

系统编码

-

└─allowLogin

boolean

是否允许登录

-

true

└─relatedLevel

int32

关联级别

-

0

└─state

int32

状态

-

0

└─linkman

string

商户联系人

-

└─linkMobile

string

商户联系电话

-

└─authType

int32

用户认证类型，0-未认证，10-个人认证，20-企业认证

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "relatedId": 0,
      "relatedUserId": 0,
      "relatedName": "",
      "mobile": "",
      "relatedType": "",
      "usableAppcodes": [
        ""
      ],
      "appcode": "",
      "allowLogin": true,
      "relatedLevel": 0,
      "state": 0,
      "linkman": "",
      "linkMobile": "",
      "authType": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

2.2.10.用户注册

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 用户注册

Body-parameters:

Parameter Type Description Required Since Example

username

string

用户名，不传默认生成

false

-

organizationName

string

企业名称

false

-

nickname

string

昵称

false

-

mobile

string

手机号

false

-

smsCode

string

短信验证码

false

-

password

string

密码

false

-

state

int32

用户状态，0:未激活，-1:已注销，10-正常

false

-

0

portrait

string

头像

false

-

email

string

邮箱

false

-

wechatNo

string

微信号

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/register' --data '{
  "username": "",
  "organizationName": "",
  "nickname": "",
  "mobile": "",
  "smsCode": "",
  "password": "",
  "state": 0,
  "portrait": "",
  "email": "",
  "wechatNo": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  }
}'

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

└─username

string

用户名

-

└─organizationName

string

组织名

-

└─nickname

string

昵称

-

└─mobile

string

手机号

-

└─wechatOpenid

string

微信openid

-

└─state

int32

用户状态，0:初始状态，-1:已注销，10-正常

-

0

└─authType

int32

认证类型，0-未认证，10-个人认证，20-企业认证

-

0

└─authTime

string

认证时间

-

yyyy-MM-dd HH:mm:ss

└─idCard

string

身份证号码

-

└─portrait

string

头像

-

└─realName

string

真实姓名

-

└─email

string

邮箱

-

└─wechatNo

string

微信号

-

└─wechatNickname

string

微信昵称

-

└─sourceAppcode

string

注册系统编码

-

└─sourceDesc

string

用户来源

-

└─sourceType

string

用户来源

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─linkAddress

object

联系地址

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─invitationCode

string

邀请码

-

└─isTest

boolean

是否测试用户

-

true

└─tenantId

int64

所属租户id

-

0

└─roleList

array

权限

-

""","""

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",
    "username": "",
    "organizationName": "",
    "nickname": "",
    "mobile": "",
    "wechatOpenid": "",
    "state": 0,
    "authType": 0,
    "authTime": "yyyy-MM-dd HH:mm:ss",
    "idCard": "",
    "portrait": "",
    "realName": "",
    "email": "",
    "wechatNo": "",
    "wechatNickname": "",
    "sourceAppcode": "",
    "sourceDesc": "",
    "sourceType": "",
    "linkman": "",
    "linkMobile": "",
    "linkAddress": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "invitationCode": "",
    "isTest": true,
    "tenantId": 0,
    "roleList": [
      ""
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.11.注册重复校验

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 注册重复校验

Body-parameters:

Parameter Type Description Required Since Example

username

string

用户名

false

-

mobile

string

手机号

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/registerRepeatVerify' --data '{
  "username": "",
  "mobile": ""
}'

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": ""
}

2.2.12.查询用户

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 查询用户

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

手机号

false

-

userId

int64

用户id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/queryUser' --data '{
  "mobile": "",
  "userId": 0
}'

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

└─username

string

用户名

-

└─nickname

string

昵称

-

└─mobile

string

手机号

-

└─state

int32

用户状态，0:未激活，-1:已注销，10-正常

-

0

└─authType

int32

认证类型，0-未认证，10-个人认证，20-企业认证

-

0

└─authTime

string

认证时间

-

yyyy-MM-dd HH:mm:ss

└─portrait

string

头像

-

└─email

string

邮箱

-

└─wechatNo

string

微信号

-

└─wechatNickname

string

微信昵称

-

└─sourceAppcode

string

注册系统编码

-

└─sourceDesc

string

用户来源

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─linkAddress

object

联系地址

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─tenantId

int64

租户id

-

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",
      "username": "",
      "nickname": "",
      "mobile": "",
      "state": 0,
      "authType": 0,
      "authTime": "yyyy-MM-dd HH:mm:ss",
      "portrait": "",
      "email": "",
      "wechatNo": "",
      "wechatNickname": "",
      "sourceAppcode": "",
      "sourceDesc": "",
      "linkman": "",
      "linkMobile": "",
      "linkAddress": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "tenantId": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

2.2.13.代理树

Type: GET

Author: wangqidong created on 2024/5/20

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 '/subgrade/account/user/agentTreeDetail/{userId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─userId

int64

用户id

-

0

└─userName

string

用户名

-

└─agentId

int64

代理id

-

0

└─agentName

string

代理名称

-

└─agentLevel

int32

代理级别

-

0

└─superAgent

object

上级代理 $ref... self

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "userId": 0,
    "userName": "",
    "agentId": 0,
    "agentName": "",
    "agentLevel": 0,
    "superAgent": {
      "$ref": "..."
    }
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.14.编辑用户信息

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 编辑用户信息

Body-parameters:

Parameter Type Description Required Since Example

nickname

string

昵称

false

-

portrait

string

头像

false

-

email

string

邮箱

false

-

wechatNo

string

微信号

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/edit' --data '{
  "nickname": "",
  "portrait": "",
  "email": "",
  "wechatNo": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  }
}'

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.15.用户认证（简单认证）

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 用户认证（简单认证）

Body-parameters:

Parameter Type Description Required Since Example

authType

enum

认证类型，10-个人，20-企业

true

-

NONE

name

string

姓名

false

-

idCard

string

身份证

false

-

mobile

string

手机号

false

-

entName

string

企业名称

false

-

entCode

string

企业识别号

false

-

businessImg

string

营业执照

false

-

email

string

邮箱

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

smsCode

string

短信验证码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/authenticate' --data '{
  "authType": 0,
  "name": "",
  "idCard": "",
  "mobile": "",
  "entName": "",
  "entCode": "",
  "businessImg": "",
  "email": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  },
  "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.2.16.查询登录手机号

Type: GET

Author: wangqidong created on 2024/5/20

Content-Type: application/x-www-form-urlencoded

Description: 查询登录手机号

Request-example:

curl -X GET -i '/subgrade/account/user/queryLoginMobile'

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.2.17.切换登录主体

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 切换登录主体

Body-parameters:

Parameter Type Description Required Since Example

relatedUserId

int64

选中的企业

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/changeLogin' --data '{
  "relatedUserId": 0
}'

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

联系方式（商户）

-

└─email

string

邮箱（商户）

-

└─isTemp

boolean

是否临时登录

-

true

└─terminal

enum

终端类型，android-安卓，ios-ios，harmony-鸿蒙
(See: 应用终端类型)

-

ANDROID

└─iv

int32

当前内部版本号

-

0

└─isTest

boolean

是否测试用户

-

true

└─refreshTime

int64

刷新时间戳

-

0

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
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.18.获取一键登录手机号

Type: POST

Author: wangqidong created on 2024/5/20

Content-Type: application/json

Description: 获取一键登录手机号

Body-parameters:

Parameter Type Description Required Since Example

accessToken

string

token

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/gainOneKeyLoginMobile' --data '{
  "accessToken": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─loginKey

string

本次认证登录key

-

└─mobile

string

手机号

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "loginKey": "",
    "mobile": ""
  },
  "timestamp": 0,
  "traceId": ""
}

2.3.用户认证

2.3.1.发起认证

Type: POST

Author: wangqidong created on 2024/10/30

Content-Type: application/json

Description: 发起认证

Body-parameters:

Parameter Type Description Required Since Example

authType

int32

认证类型，10-个人认证，20-企业认证

true

-

0

enterpriseName

string

企业姓名

false

-

enterpriseNo

string

统一社会信用编码

false

-

realName

string

真实姓名/法人姓名

false

-

idCard

string

身份证号/法人身份证

false

-

mobile

string

手机号

false

-

businessImg

string

营业执照

false

-

idCardFront

string

身份证/法人身份证正面

false

-

idCardBack

string

法人身份证法人身份证反面

false

-

workspaceImgList

array

办公场所

false

-

""","""

addressInfo

object

地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

certificationList

array

资质文件

false

-

""","""

linkman

string

联系人

false

-

linkMobile

string

联系电话

false

-

linkEmail

string

联系人邮箱

false

-

linkPosition

string

联系人职位

false

-

businessDesc

string

业务介绍

false

-

industry

string

所属行业

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/user/auth/applyAuth' --data '{
  "authType": 0,
  "enterpriseName": "",
  "enterpriseNo": "",
  "realName": "",
  "idCard": "",
  "mobile": "",
  "businessImg": "",
  "idCardFront": "",
  "idCardBack": "",
  "workspaceImgList": [
    ""
  ],
  "addressInfo": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  },
  "certificationList": [
    ""
  ],
  "linkman": "",
  "linkMobile": "",
  "linkEmail": "",
  "linkPosition": "",
  "businessDesc": "",
  "industry": ""
}'

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.2.查询认证记录

Type: GET

Author: wangqidong created on 2024/10/30

Content-Type: application/x-www-form-urlencoded

Description: 查询认证记录

Query-parameters:

Parameter Type Description Required Since Example

recordId

int64

No comments found.

false

-

0

Request-example:

curl -X GET -i '/subgrade/account/user/auth/queryAuthRecord?recordId=0'

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

└─authType

int32

认证类型，0-未认证，10-个人认证，20-企业认证

-

0

└─state

int32

状态

-

0

└─enterpriseName

string

企业姓名

-

└─enterpriseNo

string

统一社会信用编码

-

└─realName

string

真实姓名/法人姓名

-

└─idCard

string

身份证号/法人身份证

-

└─mobile

string

手机号

-

└─businessImg

string

营业执照

-

└─idCardFront

string

身份证/法人身份证正面

-

└─idCardBack

string

法人身份证法人身份证反面

-

└─workspaceImgList

array

办公场所

-

""","""

└─certificationList

array

资质文件

-

""","""

└─linkman

string

联系人

-

└─linkMobile

string

联系电话

-

└─linkEmail

string

联系人邮箱

-

└─linkPosition

string

联系人职位

-

└─businessDesc

string

业务介绍

-

└─addressInfo

object

地址

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─industry

enum

行业编码

-

LEASE3C

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─auditRemark

string

审核意见

-

└─sourceAppcode

string

注册系统编码

-

└─tenantId

int64

租户id

-

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",
    "userId": 0,
    "authType": 0,
    "state": 0,
    "enterpriseName": "",
    "enterpriseNo": "",
    "realName": "",
    "idCard": "",
    "mobile": "",
    "businessImg": "",
    "idCardFront": "",
    "idCardBack": "",
    "workspaceImgList": [
      ""
    ],
    "certificationList": [
      ""
    ],
    "linkman": "",
    "linkMobile": "",
    "linkEmail": "",
    "linkPosition": "",
    "businessDesc": "",
    "addressInfo": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "industry": "",
    "auditTime": "yyyy-MM-dd HH:mm:ss",
    "auditRemark": "",
    "sourceAppcode": "",
    "tenantId": 0
  },
  "timestamp": 0,
  "traceId": ""
}

2.4.问题反馈

2.4.1.新增投诉

Type: POST

Author: wangqidong created on 2024/7/9

Content-Type: application/json

Description: 新增投诉

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

联系电话

false

-

issueType

string

问题类型

false

-

title

string

标题

false

-

issueContent

string

问题内容

true

-

orderNo

string

业务单号

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/user/feedback/addComplaint' --data '{
  "mobile": "",
  "issueType": "",
  "title": "",
  "issueContent": "",
  "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.4.2.新增问题反馈

Type: POST

Author: wangqidong created on 2024/7/9

Content-Type: application/json

Description: 新增问题反馈

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

联系电话

false

-

issueType

string

问题类型

false

-

title

string

标题

false

-

issueContent

string

问题内容

true

-

orderNo

string

业务单号

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/user/feedback/addIssue' --data '{
  "mobile": "",
  "issueType": "",
  "title": "",
  "issueContent": "",
  "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.4.3.查询用户反馈

Type: POST

Author: wangqidong created on 2024/7/9

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

feedbackType

string

反馈类型，complaint：投诉，enroll：访客登录，issue：问题反馈

false

-

keyword

string

关键字

false

-

mobile

string

联系电话

false

-

isAccepted

boolean

是否受理

false

-

true

isSolved

boolean

是否解决

false

-

true

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 '/subgrade/user/feedback/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "feedbackType": "",
  "keyword": "",
  "mobile": "",
  "isAccepted": true,
  "isSolved": true,
  "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

     └─feedbackType

string

反馈类型，complaint：投诉，enroll：访客登录，issue：问题反馈

-

     └─userId

int64

用户id

-

0

     └─name

string

名称

-

     └─mobile

string

联系电话

-

     └─email

string

邮箱

-

     └─enterpriseName

string

企业名称

-

     └─issueType

string

问题类型

-

     └─title

string

标题

-

     └─issueContent

string

问题内容

-

     └─orderNo

string

业务单号

-

     └─isAccepted

boolean

是否受理

-

true

     └─isSolved

boolean

是否解决

-

true

     └─replyContent

string

回复内容

-

     └─solvedTime

string

解决时间

-

yyyy-MM-dd HH:mm:ss

     └─sourceTag

string

来源标记

-

     └─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",
        "feedbackType": "",
        "userId": 0,
        "name": "",
        "mobile": "",
        "email": "",
        "enterpriseName": "",
        "issueType": "",
        "title": "",
        "issueContent": "",
        "orderNo": "",
        "isAccepted": true,
        "isSolved": true,
        "replyContent": "",
        "solvedTime": "yyyy-MM-dd HH:mm:ss",
        "sourceTag": "",
        "appcode": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.4.4.访客登记

Type: POST

Author: wangqidong created on 2024/7/9

Content-Type: application/json

Description: 访客登记

Body-parameters:

Parameter Type Description Required Since Example

name

string

姓名

false

-

mobile

string

联系电话

true

-

smsCode

string

验证码

false

-

enterpriseName

string

企业名称

false

-

email

string

邮箱

false

-

remark

string

备注

false

-

sourceTag

string

来源埋点

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/user/feedback/addEnroll' --data '{
  "name": "",
  "mobile": "",
  "smsCode": "",
  "enterpriseName": "",
  "email": "",
  "remark": "",
  "sourceTag": ""
}'

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/28

Content-Type: application/json

Description: 新增抬头

Body-parameters:

Parameter Type Description Required Since Example

invoiceType

string

开票类型，normal-普票，special-专票

true

-

name

string

发票抬头

true

-

tin

string

税号

true

-

email

string

邮箱

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/invoiceHeader/add' --data '{
  "invoiceType": "",
  "name": "",
  "tin": "",
  "email": ""
}'

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.抬头列表

Type: POST

Author: wangqidong created on 2024/10/28

Content-Type: application/json

Description: 抬头列表

Body-parameters:

Parameter Type Description Required Since Example

invoiceType

string

开票类型，normal-普票，special-专票

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/invoiceHeader/list' --data '{
  "invoiceType": ""
}'

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

└─userId

int64

用户id

-

0

└─username

string

用户名f

-

└─invoiceType

string

开票类型，normal-普票，special-专票

-

└─name

string

发票抬头

-

└─tin

string

税号

-

└─email

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,
      "username": "",
      "invoiceType": "",
      "name": "",
      "tin": "",
      "email": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

2.5.3.删除抬头

Type: POST

Author: wangqidong created on 2024/10/28

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 '/subgrade/account/invoiceHeader/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.5.4.编辑抬头信息

Type: POST

Author: wangqidong created on 2024/10/28

Content-Type: application/json

Description: 编辑抬头信息

Body-parameters:

Parameter Type Description Required Since Example

id

int64

抬头id

true

-

0

email

string

邮箱

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/account/invoiceHeader/edit' --data '{
  "id": 0,
  "email": ""
}'

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.基础服务

3.1.ocr相关

3.1.1.身份证ocr

Type: POST

Author: wangqidong created on 2024/7/9

Content-Type: multipart/form-data

Description: 身份证ocr

Body-parameters:

Parameter Type Description Required Since Example

file

file

No comments found.

false

-

url

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: multipart/form-data" -F 'file=' -i '/subgrade/basic/ocr/idCardOcr?url='

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─name

string

姓名

-

└─idCard

string

身份证号

-

└─gender

string

性别

-

└─nation

string

民族

-

└─birthday

string

生日，格式，yyyyMMdd

-

└─address

string

地址

-

└─authority

string

签发机关

-

└─validDateStart

string

有效期限起始，格式，yyyyMMdd

-

└─validDateEnd

string

有效期限截止，格式，yyyyMMdd

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "name": "",
    "idCard": "",
    "gender": "",
    "nation": "",
    "birthday": "",
    "address": "",
    "authority": "",
    "validDateStart": "",
    "validDateEnd": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.1.2.营业执照ocr

Type: POST

Author: wangqidong created on 2024/7/9

Content-Type: multipart/form-data

Description: 营业执照ocr

Body-parameters:

Parameter Type Description Required Since Example

file

file

No comments found.

false

-

url

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: multipart/form-data" -F 'file=' -i '/subgrade/basic/ocr/businessLicence?url='

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─creditCode

string

统一社会信用代码

-

└─registrationCode

string

注册号，证件上未检出则为空

-

└─enterpriseName

string

企业名称

-

└─enterpriseType

string

企业类型

-

└─lrName

string

法人（或经营者）姓名

-

└─registrationCapital

string

注册资本

-

└─establishingDate

string

成立时间，返回“YYYY-MM-DD”的标准日期格式。若解析失败，则返回识别纯文本行原始内容。

-

└─opPeriod

string

经营日期开始至结束时间，返回字符串“YYYY年MM月DD日至YYYY年MM月DD日”。

-

└─opFrom

string

经营日期开始日期,返回“YYYY-MM-DD”的标准日期格式，若解析失败，此字段为空，可参考opPeriod返回值。

-

└─opTo

string

经营结束日期，返回“YYYY-MM-DD”的标准日期格式，若解析失败，此字段为空，可参考opPeriod返回值。

-

└─address

string

地址（或经营场所）

-

└─opScope

string

经营范围（适用于企业）

-

└─orgForm

string

组成形式

-

└─addressInfo

object

地址明细

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─url

string

url

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "creditCode": "",
    "registrationCode": "",
    "enterpriseName": "",
    "enterpriseType": "",
    "lrName": "",
    "registrationCapital": "",
    "establishingDate": "",
    "opPeriod": "",
    "opFrom": "",
    "opTo": "",
    "address": "",
    "opScope": "",
    "orgForm": "",
    "addressInfo": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "url": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.1.3.行驶证ocr

Type: POST

Author: wangqidong created on 2024/7/9

Content-Type: multipart/form-data

Description: 行驶证ocr

Body-parameters:

Parameter Type Description Required Since Example

file

file

2m以内，file和url二选一，优先url

false

-

url

string

2m以内，file和url二选一，优先url

false

-

Request-example:

curl -X POST -H "Content-Type: multipart/form-data" -F 'file=' -i '/subgrade/basic/ocr/vehicleLicense?url='

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─first

object

正页

-

     └─plateNo

string

号牌号码

-

     └─vType

string

车辆类型

-

     └─owner

string

所有人

-

     └─address

string

地址

-

     └─useCharacter

string

使用性质

-

     └─model

string

品牌型号

-

     └─vin

string

车辆识别代码 VIN

-

     └─engineNo

string

发动机号

-

     └─registerDate

string

注册日期

-

     └─issueDate

string

发证日期

-

     └─authority

string

发证机关

-

└─second

object

副页

-

     └─dPPlateNo

string

号牌号码

-

     └─fileNo

string

档案编号

-

     └─peopleNo

string

核定载人数

-

     └─totalMass

string

总质量

-

     └─unladenMass

string

整备质量

-

     └─ladenMass

string

核定载质量

-

     └─outlineSize

string

外廓尺寸

-

     └─tractionMass

string

准牵引总质量

-

     └─dPNo

string

副页条码编号

-

     └─reMarks

string

备注

-

     └─record

string

检验记录

-

     └─fuelType

string

燃料种类

-

└─url

string

行驶证图片url

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "first": {
      "plateNo": "",
      "vType": "",
      "owner": "",
      "address": "",
      "useCharacter": "",
      "model": "",
      "vin": "",
      "engineNo": "",
      "registerDate": "",
      "issueDate": "",
      "authority": ""
    },
    "second": {
      "dPPlateNo": "",
      "fileNo": "",
      "peopleNo": "",
      "totalMass": "",
      "unladenMass": "",
      "ladenMass": "",
      "outlineSize": "",
      "tractionMass": "",
      "dPNo": "",
      "reMarks": "",
      "record": "",
      "fuelType": ""
    },
    "url": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.2.字典管理

3.2.1.查询字典

Type: POST

Author: wangqidong created on 2024/8/9

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

pcode

string

上级编码，查询第一级传0

true

-

code

string

编码

false

-

onlyEnable

boolean

是否仅查询生效记录，默认true

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/dict/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "pcode": "",
  "code": "",
  "onlyEnable": 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

     └─pcode

string

上级字典编码

-

     └─code

string

字典编码

-

     └─name

string

字典名称

-

     └─value

string

字典值

-

     └─enable

boolean

启用状态：0：禁用 1：启用

-

true

     └─sort

int32

显示顺序

-

0

     └─level

int32

等级

-

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",
        "pcode": "",
        "code": "",
        "name": "",
        "value": "",
        "enable": true,
        "sort": 0,
        "level": 0,
        "remark": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.2.2.查询下级字典值

Type: GET

Author: wangqidong created on 2024/8/9

Content-Type: application/x-www-form-urlencoded

Description: 查询下级字典值

Path-parameters:

Parameter Type Description Required Since Example

pcode

string

No comments found.

true

-

Request-example:

curl -X GET -i '/subgrade/basic/dict/querySubValue/{pcode}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─mapKey

string

A map key.

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "mapKey1": "",
    "mapKey2": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.2.3.查询特定字典值

Type: POST

Author: wangqidong created on 2024/8/9

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

pcode

string

上级编码，查询第一级传0

true

-

code

string

编码

false

-

onlyEnable

boolean

是否仅查询生效记录，默认true

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/dict/querySpecial' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "pcode": "",
  "code": "",
  "onlyEnable": true
}'

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": ""
}

3.3.短信服务

3.3.1.发送验证码

Type: POST

Author: wangqidong created on 2024/5/22

Content-Type: application/json

Description: 发送验证码

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

手机号 Validation[Pattern(regexp=1[3-9]\d{9}, message= 手机号格式错误)]

false

-

receiver

string

邮箱

false

-

sceneCode

string

场景编码 Validation[Length(max=32, min=0, message=场景编码长度超出限制)]

true

-

method

enum

发送方式，sms-短信（默认），email-邮箱
(See: 验证码渠道)

false

-

SMS

captchaToken

string

人机验证token，captchaToken和verifyParams二选一

false

-

verifyParams

string

人机验证参数，captchaToken和verifyParams二选一 不推荐使用

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/sms/sendVerifyCode' --data '{
  "mobile": "",
  "receiver": "",
  "sceneCode": "",
  "method": "",
  "captchaToken": "",
  "verifyParams": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─validTime

int32

验证码有效时间，单位：秒

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "validTime": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.2.人机验证

Type: POST

Author: wangqidong created on 2024/5/22

Content-Type: application/json

Description: 人机验证

Body-parameters:

Parameter Type Description Required Since Example

verifyParams

string

校验参数

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/sms/captchaVerify' --data '{
  "verifyParams": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─token

string

验证成功token

-

└─validSeconds

int32

有效时间，秒

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "token": "",
    "validSeconds": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.4.协议相关

3.4.1.签署协议列表

Type: POST

Author: wangqidong created on 2024/5/20

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 '/subgrade/basic/protocol/signList' --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

-

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": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.5.文件处理

3.5.1.上传文件

Type: POST

Author: wangqidong created on 2024/5/31

Content-Type: multipart/form-data

Description: 上传文件

Body-parameters:

Parameter Type Description Required Since Example

file

file

No comments found.

true

-

isAttachment

boolean

No comments found.

true

-

false

expireDays

int32

No comments found.

false

-

0

Request-example:

curl -X POST -H "Content-Type: multipart/form-data" -F 'file=' -i '/subgrade/basic/file/upload?isAttachment=false&expireDays=0'

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": ""
}

3.5.2.生成二维码

Type: POST

Author: wangqidong created on 2024/5/31

Content-Type: application/json

Description: 生成二维码

Body-parameters:

Parameter Type Description Required Since Example

content

string

二维码内容，长度最大2000 Validation[Length(max=2000, min=0, message=二维码内容长度超出限制)]

true

-

logo

string

logo链接

false

-

validDays

int32

二维码链接有效天数，默认1天

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/file/genQrCode' --data '{
  "content": "",
  "logo": "",
  "validDays": 0
}'

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": ""
}

3.6.应用

3.6.1.查询应用配置

Type: GET

Author: wangqidong created on 2024/5/27

Content-Type: application/x-www-form-urlencoded

Description: 查询应用配置

Request-example:

curl -X GET -i '/subgrade/basic/app/queryConfig'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─servUrl

string

客服地址

-

└─wechatServUrl

string

微信客服

-

└─innerVersion

int32

内部版本号

-

0

└─currentVersion

string

当前版本

-

└─mustUpgrade

boolean

是否强制更新

-

true

└─upgradeDescList

array

更新说明

-

""","""

└─upgradePage

string

更新页面

-

└─downloadPage

object

下载页

-

     └─android

string

安卓

-

     └─ios

string

ios

-

└─latestPublish

object

最新版本

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─appcode

string

应用编码

-

     └─appName

string

应用名

-

     └─terminal

string

终端类型，android-安卓，ios-ios，harmony-鸿蒙

-

     └─versionNo

string

最新应用版本号

-

     └─innerVersion

int32

最新内部版本号

-

0

     └─mustUpgrade

boolean

是否必须升级

-

true

     └─upgradePage

string

更新页地址

-

     └─downloadUrl

string

下载页配置

-

     └─isValid

boolean

是否有效

-

true

     └─notes

array

更新说明

-

""","""

└─routeUrl

string

首页路由

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "servUrl": "",
    "wechatServUrl": "",
    "innerVersion": 0,
    "currentVersion": "",
    "mustUpgrade": true,
    "upgradeDescList": [
      ""
    ],
    "upgradePage": "",
    "downloadPage": {
      "android": "",
      "ios": ""
    },
    "latestPublish": {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "appcode": "",
      "appName": "",
      "terminal": "",
      "versionNo": "",
      "innerVersion": 0,
      "mustUpgrade": true,
      "upgradePage": "",
      "downloadUrl": "",
      "isValid": true,
      "notes": [
        ""
      ]
    },
    "routeUrl": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.6.2.页面配置

Type: GET

Author: wangqidong created on 2024/5/27

Content-Type: application/x-www-form-urlencoded

Description: 页面配置

Request-example:

curl -X GET -i '/subgrade/basic/app/pageConfig'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─indexMenus

array

首页菜单

-

     └─title

string

标题

-

     └─icon

string

图标

-

     └─route

string

路由

-

     └─type

string

类型

-

     └─field

string

字段

-

└─spreadStatistics

array

推广统计

-

     └─title

string

标题

-

     └─icon

string

图标

-

     └─route

string

路由

-

     └─type

string

类型

-

     └─field

string

字段

-

└─mineOptions

array

我的页面菜单

-

     └─title

string

标题

-

     └─icon

string

图标

-

     └─route

string

路由

-

     └─type

string

类型

-

     └─field

string

字段

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "indexMenus": [
      {
        "title": "",
        "icon": "",
        "route": "",
        "type": "",
        "field": ""
      }
    ],
    "spreadStatistics": [
      {
        "title": "",
        "icon": "",
        "route": "",
        "type": "",
        "field": ""
      }
    ],
    "mineOptions": [
      {
        "title": "",
        "icon": "",
        "route": "",
        "type": "",
        "field": ""
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

3.6.3.应用列表

Type: POST

Author: wangqidong created on 2024/5/27

Content-Type: application/json

Description: 应用列表

Body-parameters:

Parameter Type Description Required Since Example

keyword

string

关键字查询

false

-

appcodes

array

应用编码

false

-

""","""

mustRegistrable

boolean

是否必须可在线注册

false

-

true

walletEnabled

boolean

是否要求已启用钱包账户

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/app/list' --data '{
  "keyword": "",
  "appcodes": [
    ""
  ],
  "mustRegistrable": true,
  "walletEnabled": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─appcode

string

应用编码

-

└─appName

string

应用名称

-

└─appType

string

应用类型，miniapp-小程序，mp-公众号

-

└─systemCode

string

所属系统编码

-

└─domain

string

域名

-

└─logo

string

应用logo

-

└─tenantId

int64

默认所属租户id

-

0

└─bizAppList

array

关联的业务系统

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "appcode": "",
      "appName": "",
      "appType": "",
      "systemCode": "",
      "domain": "",
      "logo": "",
      "tenantId": 0,
      "bizAppList": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.6.4.公告列表

Type: POST

Author: wangqidong created on 2024/5/27

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

-

pushTypeList

array

推送方式，1-站内通知，2-app通知，3-短信，4-邮件，多个逗号分割

false

-

"0,0"

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 '/subgrade/basic/app/informList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "pushTypeList": [
    0
  ],
  "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": ""
}

3.6.5.查询banner

Type: GET

Author: wangqidong created on 2024/5/27

Content-Type: application/x-www-form-urlencoded

Description: 查询banner

Path-parameters:

Parameter Type Description Required Since Example

sceneCode

string

No comments found.

true

-

Request-example:

curl -X GET -i '/subgrade/basic/app/bannerList/{sceneCode}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─sceneCode

string

场景编码

-

└─image

string

图片地址

-

└─jumpUrl

string

跳转地址

-

└─jumpType

string

跳转类型，inner-内部，outer-外部

-

└─appcode

string

应用编码

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "sceneCode": "",
      "image": "",
      "jumpUrl": "",
      "jumpType": "",
      "appcode": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.7.验证相关

3.7.1.人机验证

Type: POST

Author: wangqidong created on 2024/8/1

Content-Type: application/json

Description: 人机验证

Body-parameters:

Parameter Type Description Required Since Example

verifyParams

string

校验参数

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/validate/captchaVerify' --data '{
  "verifyParams": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─token

string

验证成功token

-

└─validSeconds

int32

有效时间，秒

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "token": "",
    "validSeconds": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.8.行政区划

3.8.1.编码翻译

Type: GET

Author: wangqidong created on 2024/7/23

Content-Type: application/x-www-form-urlencoded

Description: 编码翻译

Path-parameters:

Parameter Type Description Required Since Example

code

string

No comments found.

true

-

Request-example:

curl -X GET -i '/subgrade/basic/region/translate/{code}'

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": ""
}

3.8.2.查询行政区划

Type: POST

Author: wangqidong created on 2024/7/23

Content-Type: application/json

Description: 查询行政区划

Body-parameters:

Parameter Type Description Required Since Example

pcode

string

上级编码，查询省级行政区传0

true

-

nameLike

string

名称模糊匹配，不为空recursionDepth参数会失效

false

-

recurseDepth

int32

下级递归深度，0-不查询下级（默认），最大为2 Validation[Min(value=0, message=递归深度最小为0); Max(value=3, message=递归深度最大为2)]

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/region/list' --data '{
  "pcode": "",
  "nameLike": "",
  "recurseDepth": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

区域id

-

0

└─code

string

区划代码

-

└─name

string

名称

-

└─level

boolean

级别1-5,省市县镇村

-

true

└─pcode

string

父级区划代码

-

└─category

int32

城乡分类

-

0

└─subList

array

下级列表

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "code": "",
      "name": "",
      "level": true,
      "pcode": "",
      "category": 0,
      "subList": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.9.常用工具

3.9.1.金额转中文

Type: GET

Author: wangqidong created on 2025/2/22

Content-Type: application/x-www-form-urlencoded

Description: 金额转中文

Query-parameters:

Parameter Type Description Required Since Example

num

number

数字，需大于，最多三位小数

true

-

0

toSmall

boolean

是否转中文小写

true

-

false

Request-example:

curl -X GET -i '/subgrade/basic/toolkits/moneyToCn?num=0&toSmall=false'

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": ""
}

3.10.站内信

3.10.1.设置消息已读

Type: POST

Author: wangqidong created on 2024/7/9

Content-Type: application/json

Description: 设置消息已读

Body-parameters:

Parameter Type Description Required Since Example

messageIds

array

消息id数组

false

-

"0,0"

readAll

boolean

是否全部已读，默认false

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/basic/appMessage/read' --data '{
  "messageIds": [
    0
  ],
  "readAll": 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": ""
}

3.10.2.查询业务消息

Type: POST

Author: wangqidong created on 2024/7/9

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

msgType

string

消息类型

false

-

pushTypeList

array

推送方式，1-站内通知，2-app通知，3-短信，4-邮件，多个逗号分割

false

-

"0,0"

isRead

boolean

阅读状态 0 未读 1 已读

false

-

true

msgTagList

array

消息标签

false

-

""","""

queryNews

boolean

查询新消息

false

-

true

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 '/subgrade/basic/appMessage/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "msgType": "",
  "pushTypeList": [
    0
  ],
  "isRead": true,
  "msgTagList": [
    ""
  ],
  "queryNews": true,
  "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

     └─msgType

string

消息类型

-

     └─title

string

标题

-

     └─content

string

内容

-

     └─jumpConfig

object

跳转配置，仅对站内通知有效

-

          └─type

enum

类型

-

INNER

          └─text

string

链接展示名称

-

          └─url

string

地址

-

          └─newLabel

boolean

是否在新标签页打开

-

true

     └─pushTypeList

array

推送方式，1-站内通知，2-app通知，3-短信，4-邮件，多个逗号分割

-

"0,0"

     └─isRead

boolean

阅读状态 0 未读 1 已读

-

true

     └─msgTagList

array

消息标签

-

""","""

└─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",
        "msgType": "",
        "title": "",
        "content": "",
        "jumpConfig": {
          "type": "",
          "text": "",
          "url": "",
          "newLabel": true
        },
        "pushTypeList": [
          0
        ],
        "isRead": true,
        "msgTagList": [
          ""
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.11.短链服务

3.11.1.短域名解析

Type: GET

Author: wangqidong created on 2025/7/4

Content-Type: application/x-www-form-urlencoded

Description: 短域名解析

Path-parameters:

Parameter Type Description Required Since Example

code

string

No comments found.

true

-

Request-example:

curl -X GET -i '/subgrade/basic/shortLink/parse/{code}'

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

└─jumpType

string

跳转类型，normal-普通跳转，wechatMp-微信公众号，wechatMini-微信小程序

-

└─code

string

短链码

-

└─endpoint

string

短域名

-

└─originUrl

string

原网址

-

└─state

int32

状态，-1：已失效（或不存在），0：待审核，10：正常，20：已过期，30：访问次数超出限制

-

0

└─expireTime

string

过期时间

-

yyyy-MM-dd HH:mm:ss

└─maxAccessCount

int32

最大访问次数

-

0

└─accessedCount

int32

已访问次数

-

0

└─lastAccessTime

string

最后一次访问时间

-

yyyy-MM-dd HH:mm:ss

└─shortUrl

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",
    "jumpType": "",
    "code": "",
    "endpoint": "",
    "originUrl": "",
    "state": 0,
    "expireTime": "yyyy-MM-dd HH:mm:ss",
    "maxAccessCount": 0,
    "accessedCount": 0,
    "lastAccessTime": "yyyy-MM-dd HH:mm:ss",
    "shortUrl": ""
  },
  "timestamp": 0,
  "traceId": ""
}

4.支付相关

4.1.支付

4.1.1.创建支付单

Type: POST

Author: wangqidong created on 2024/5/28

Content-Type: application/json

Description: 创建支付单

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

用户id

true

-

0

businessType

string

业务类型，由业务方指定

true

-

businessNo

string

业务单号，不可重复，同一笔单号只可发起一次

true

-

payMethod

enum

支付方式
(See: 支付方式)

false

-

WALLET

feeName

string

费用项名称

true

-

originAmount

number

原始订单金额

false

-

0

applyAmount

number

申请支付金额

true

-

0

payerOpenid

string

支付人openid

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/pay/payment/createPayOrder' --data '{
  "userId": 0,
  "businessType": "",
  "businessNo": "",
  "payMethod": "",
  "feeName": "",
  "originAmount": 0,
  "applyAmount": 0,
  "payerOpenid": ""
}'

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": ""
}

4.1.2.查询支付单进行支付

Type: POST

Author: wangqidong created on 2024/5/28

Content-Type: application/json

Description: 查询支付单进行支付

Body-parameters:

Parameter Type Description Required Since Example

payNo

string

支付单号（支付单号、业务单号二选一传递即可）

false

-

businessNo

string

业务单号（支付单号、业务单号二选一传递即可）

false

-

businessType

string

businessNo不为空时必填

false

-

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 '/subgrade/pay/payment/queryForPay' --data '{
  "payNo": "",
  "businessNo": "",
  "businessType": "",
  "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": ""
}

4.1.3.支付方式查询

Type: GET

Author: wangqidong created on 2024/5/28

Content-Type: application/x-www-form-urlencoded

Description: 支付方式查询

Path-parameters:

Parameter Type Description Required Since Example

scene

string

支付场景，bizPay-通用业务支付，recharge-账户充值

true

-

Request-example:

curl -X GET -i '/subgrade/pay/payment/queryUsablePayMethods/{scene}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─payMethod

string

支付方式

-

└─name

string

名称

-

└─logo

string

Logo

-

└─balance

number

账户余额（余额支付才会返回）

-

0

└─isDefault

boolean

是否默认

-

true

└─sort

int32

排序

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "payMethod": "",
      "name": "",
      "logo": "",
      "balance": 0,
      "isDefault": true,
      "sort": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.1.4.申请支付

Type: POST

Author: wangqidong created on 2024/5/28

Content-Type: application/json

Description: 申请支付

Body-parameters:

Parameter Type Description Required Since Example

payNo

string

支付单号

true

-

payMethod

enum

支付方式，发起支付时可不指定
(See: 支付方式)

true

-

WALLET

applyAppType

string

申请支付端类型

false

-

returnUrl

string

支付完成返回地址

false

-

quitUrl

string

中途退出返回地址

false

-

payerOpenid

string

支付人openid

false

-

properScene

string

专属场景编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/pay/payment/applyPay' --data '{
  "payNo": "",
  "payMethod": "",
  "applyAppType": "",
  "returnUrl": "",
  "quitUrl": "",
  "payerOpenid": "",
  "properScene": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

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

钱包流水编号，钱包支付会记录

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "isPaid": true,
    "logo": "",
    "payData": {
      "logo": "",
      "expireSeconds": 0,
      "payUrl": "",
      "payInfo": "",
      "wechatPayExtra": {
        "appId": "",
        "timeStamp": "",
        "nonceStr": "",
        "package": "",
        "signType": "",
        "paySign": ""
      }
    },
    "payAccountId": 0,
    "walletFlowNo": ""
  },
  "timestamp": 0,
  "traceId": ""
}

4.1.5.查询支付结果

Type: GET

Author: wangqidong created on 2024/5/28

Content-Type: application/x-www-form-urlencoded

Description: 查询支付结果

Path-parameters:

Parameter Type Description Required Since Example

payNo

string

No comments found.

true

-

Request-example:

curl -X GET -i '/subgrade/pay/payment/payResult/{payNo}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─payNo

string

支付单号

-

└─state

int32

状态，20-已支付

-

0

└─amount

number

金额

-

0

└─paidTime

string

支付时间

-

yyyy-MM-dd HH:mm:ss

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "payNo": "",
    "state": 0,
    "amount": 0,
    "paidTime": "yyyy-MM-dd HH:mm:ss"
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.钱包账户

4.2.1.申请充值

Type: POST

Author: wangqidong created on 2024/5/23

Content-Type: application/json

Description: 申请充值

Body-parameters:

Parameter Type Description Required Since Example

walletId

int64

账户id，未指定取登录用户匹配

false

-

0

rechargeAmount

number

充值金额金额

true

-

0

payMethod

enum

支付方式
(See: 支付方式)

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 '/subgrade/pay/wallet/preRecharge' --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": ""
}

4.2.2.钱包流水

Type: POST

Author: wangqidong created on 2024/5/23

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

properScene

string

专属场景编码

false

-

flowType

string

流水类型，in-收入，out-支出

false

-

bizTypeList

array

业务类型，bizPay-支付，recharge-账户充值，refund-退款

false

-

""","""

createTimeGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

privacyScope

boolean

是否私域查询，默认true

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/pay/wallet/flowList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "properScene": "",
  "flowType": "",
  "bizTypeList": [
    ""
  ],
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss",
  "privacyScope": 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

     └─walletId

int64

钱包id

-

0

     └─flowNo

string

流水号

-

     └─flowType

string

流水类型，in-收入，out-支出

-

     └─bizType

string

业务类型，pay-支付，recharge-账户充值，refund-退款

-

     └─payMethod

string

支付方式

-

     └─businessNo

string

业务单号

-

     └─feeName

string

费用项名称

-

     └─flowAmount

number

金额

-

0

     └─afterBalance

number

操作后余额

-

0

     └─tenantId

int64

租户id

-

0

     └─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",
        "walletId": 0,
        "flowNo": "",
        "flowType": "",
        "bizType": "",
        "payMethod": "",
        "businessNo": "",
        "feeName": "",
        "flowAmount": 0,
        "afterBalance": 0,
        "tenantId": 0,
        "appcode": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.3.查询账户余额

Type: GET

Author: wangqidong created on 2024/5/23

Content-Type: application/x-www-form-urlencoded

Description: 查询账户余额

Request-example:

curl -X GET -i '/subgrade/pay/wallet/queryBalance'

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": ""
}

4.2.4.匹配账户

Type: POST

Author: wangqidong created on 2024/5/23

Content-Type: application/json

Description: 匹配账户

Body-parameters:

Parameter Type Description Required Since Example

properScene

string

专属场景编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/pay/wallet/matchAccount' --data '{
  "properScene": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

钱包id

-

0

└─userId

int64

用户id

-

0

└─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

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "userId": 0,
    "accountType": 0,
    "isDefault": true,
    "state": 0,
    "balance": 0,
    "overdraftState": 0,
    "overdraftQuota": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.5.平台对公账户信息

Type: GET

Author: wangqidong created on 2024/5/23

Content-Type: application/x-www-form-urlencoded

Description: 平台对公账户信息

Request-example:

curl -X GET -i '/subgrade/pay/wallet/queryPlatformAccount'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─accountName

string

账户名称

-

└─bankName

string

开户银行

-

└─bankAccount

string

银行开户账号

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "accountName": "",
    "bankName": "",
    "bankAccount": ""
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.6.查询预设充值额度

Type: GET

Author: wangqidong created on 2024/5/23

Content-Type: application/x-www-form-urlencoded

Description: 查询预设充值额度

Query-parameters:

Parameter Type Description Required Since Example

walletId

int64

No comments found.

false

-

0

Request-example:

curl -X GET -i '/subgrade/pay/wallet/queryPresetRechargeQuota?walletId=0'

Response-fields:

Field Type Description Since Example

code

int32

响应码，0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─quota

number

充值额度

-

0

└─giveQuota

number

赠送金额

-

0

└─onlyNewGive

boolean

赠送金额是否新客专享

-

true

└─custom

boolean

是否是自定义充值

-

true

└─min

number

自定义充值最小额度

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "quota": 0,
      "giveQuota": 0,
      "onlyNewGive": true,
      "custom": true,
      "min": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.2.7.手动充值

Type: POST

Author: wangqidong created on 2024/5/23

Content-Type: application/json

Description: 手动充值

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

账户id

true

-

0

appcode

string

应用编码，传递merchantId时必须

true

-

rechargeAmount

number

充值金额

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/subgrade/pay/wallet/manualRecharge' --data '{
  "merchantId": 0,
  "appcode": "",
  "rechargeAmount": 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": ""
}
Top