浩保行 API 接口文档

管理后台和用户 App(小程序)的完整接口文档

概览

本接口文档基于 OpenAPI 3.1.0 规范生成,包含浩保行系统的管理后台和用户 App(小程序)两部分接口。

服务器地址: http://tjhbh-api.agy.top

认证方式: Bearer Token(在请求头中携带 Authorization 参数)

租户编号: 在请求头中携带 tenant-id 参数,默认值为 1

管理后台 API

📁 用户 (5个接口)

PUT/admin-api/system/user/update修改用户

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

UserSaveReqVO

响应结果

状态码描述
200OK
PUT/admin-api/system/user/update-status修改用户状态

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

UserUpdateStatusReqVO

响应结果

状态码描述
200OK
PUT/admin-api/system/user/update-password重置用户密码

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

UserUpdatePasswordReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/user/import导入用户

请求参数

参数名位置类型描述
updateSupportqueryboolean是否支持更新,默认为 false
file*queryExcel 文件
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

无请求体

响应结果

状态码描述
200OK
POST/admin-api/system/user/create新增用户

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

UserSaveReqVO

响应结果

状态码描述
200OK

📁 用户个人中心 (3个接口)

PUT/admin-api/system/user/profile/update修改用户个人信息

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

UserProfileUpdateReqVO

响应结果

状态码描述
200OK
PUT/admin-api/system/user/profile/update-password修改用户个人密码

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

UserProfileUpdatePasswordReqVO

响应结果

状态码描述
200OK
GET/admin-api/system/user/profile/get获得登录用户信息

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

无请求体

响应结果

状态码描述
200OK

📁 租户 (2个接口)

PUT/admin-api/system/tenant/update更新租户

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

TenantSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/tenant/create创建租户

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

TenantSaveReqVO

响应结果

状态码描述
200OK

📁 租户套餐 (2个接口)

PUT/admin-api/system/tenant-package/update更新租户套餐

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

TenantPackageSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/tenant-package/create创建租户套餐

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

TenantPackageSaveReqVO

响应结果

状态码描述
200OK

📁 社交客户端 (3个接口)

PUT/admin-api/system/social-client/update更新社交客户端

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SocialClientSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/social-client/send-subscribe-message发送订阅消息

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SocialWxaSubscribeMessageSendReqDTO

响应结果

状态码描述
200OK
POST/admin-api/system/social-client/create创建社交客户端

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SocialClientSaveReqVO

响应结果

状态码描述
200OK

📁 社交用户 (1个接口)

POST/admin-api/system/social-user/bind社交绑定,使用 code 授权码

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SocialUserBindReqVO

响应结果

状态码描述
200OK

📁 短信模板 (3个接口)

PUT/admin-api/system/sms-template/update更新短信模板

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SmsTemplateSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/sms-template/send-sms发送短信

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SmsTemplateSendReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/sms-template/create创建短信模板

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SmsTemplateSaveReqVO

响应结果

状态码描述
200OK

📁 短信渠道 (2个接口)

PUT/admin-api/system/sms-channel/update更新短信渠道

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SmsChannelSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/sms-channel/create创建短信渠道

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

SmsChannelSaveReqVO

响应结果

状态码描述
200OK

📁 角色 (2个接口)

PUT/admin-api/system/role/update修改角色

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

RoleSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/role/create创建角色

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

RoleSaveReqVO

响应结果

状态码描述
200OK

📁 岗位 (2个接口)

PUT/admin-api/system/post/update修改岗位

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

PostSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/post/create创建岗位

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

PostSaveReqVO

响应结果

状态码描述
200OK

📁 OAuth2.0 用户 (1个接口)

PUT/admin-api/system/oauth2/user/update更新用户基本信息

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

OAuth2UserUpdateReqVO

响应结果

状态码描述
200OK

📁 OAuth2 客户端 (2个接口)

PUT/admin-api/system/oauth2-client/update更新 OAuth2 客户端

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

OAuth2ClientSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/oauth2-client/create创建 OAuth2 客户端

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

OAuth2ClientSaveReqVO

响应结果

状态码描述
200OK

📁 站内信模版 (2个接口)

PUT/admin-api/system/notify-template/update更新站内信模版

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

NotifyTemplateSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/notify-template/create创建站内信模版

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

NotifyTemplateSaveReqVO

响应结果

状态码描述
200OK

📁 我的站内信 (2个接口)

PUT/admin-api/system/notify-message/update-read标记站内信为已读

请求参数

参数名位置类型描述
ids*queryarray (int64)编号列表
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

无请求体

响应结果

状态码描述
200OK
PUT/admin-api/system/notify-message/update-all-read标记所有站内信为已读

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

无请求体

响应结果

状态码描述
200OK

📁 通知公告 (2个接口)

PUT/admin-api/system/notice/update修改通知公告

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

NoticeSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/notice/create创建通知公告

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

NoticeSaveReqVO

响应结果

状态码描述
200OK

📁 菜单 (2个接口)

PUT/admin-api/system/menu/update修改菜单

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

MenuSaveVO

响应结果

状态码描述
200OK
POST/admin-api/system/menu/create创建菜单

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

MenuSaveVO

响应结果

状态码描述
200OK

📁 邮件模版 (2个接口)

PUT/admin-api/system/mail-template/update修改邮件模版

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

MailTemplateSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/mail-template/create创建邮件模版

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

MailTemplateSaveReqVO

响应结果

状态码描述
200OK

📁 邮箱账号 (2个接口)

PUT/admin-api/system/mail-account/update修改邮箱账号

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

MailAccountSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/mail-account/create创建邮箱账号

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

MailAccountSaveReqVO

响应结果

状态码描述
200OK

📁 字典类型 (2个接口)

PUT/admin-api/system/dict-type/update修改字典类型

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

DictTypeSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/dict-type/create创建字典类型

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

DictTypeSaveReqVO

响应结果

状态码描述
200OK

📁 字典数据 (2个接口)

PUT/admin-api/system/dict-data/update修改字典数据

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

DictDataSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/dict-data/create创建字典数据

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

DictDataSaveReqVO

响应结果

状态码描述
200OK

📁 部门 (2个接口)

PUT/admin-api/system/dept/update更新部门

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

DeptSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/system/dept/create创建部门

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

DeptSaveReqVO

响应结果

状态码描述
200OK

📁 新闻管理 (2个接口)

PUT/admin-api/insuranceMange/news/update更新新闻管理

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

InsuranceNewsSaveReqVO

响应结果

状态码描述
200OK
POST/admin-api/insuranceMange/news/create创建新闻管理

请求参数

参数名位置类型描述
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

InsuranceNewsSaveReqVO

响应结果

状态码描述
200OK

用户 App API

📁 保险订单 (2个接口)

PUT/app-api/insurance/order/pay支付订单

请求参数

参数名位置类型描述
id*queryinteger (int64)编号
payNoquerystring
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

无请求体

响应结果

状态码描述
200OK
PUT/app-api/insurance/order/cancel取消订单

请求参数

参数名位置类型描述
id*queryinteger (int64)编号
tenant-idheaderinteger (int32)租户编号
Authorizationheaderstring认证 Token

请求体

无请求体

响应结果

状态码描述
200OK