用户接口
User 对象
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 用户id |
| username | string | 用户名 |
| role | string | 用户角色 |
| area_code | string | 手机区号 |
| mobile | string | 手机号 |
| cert_type | number | 认证类型, 0未认证，1公司，2个人 |
| promotion_code | string | 推广码 |
| last_login | string | 上次登录时间 |
| created_at | string | 创建时间 |
| updated_at | string | 更新时间 |
检查邮箱是否可注册
URL: POST /user/check_email
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 用户名，邮箱格式 |
输出: 无, 200表示可用
检查手机号是否可注册
URL: POST /user/check_mobile
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| area_code | string | 是 | 手机区号, 如852 |
| mobile | string | 是 | 手机号，如13900000000 |
输出: 无, 200表示可用
注册
URL: POST /user/register
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 用户名，邮箱格式 |
| area_code | string | 是 | 手机区号, 如852 |
| mobile | string | 是 | 手机号，如13900000000 |
| password | string | 是 | 密码 |
| promotion_code | string | 否 | 邀请码 |
| cert_type | number | 是 | 认证类型, 1公司注册, 2个人注册 |
当公司注册时，以下参数必填
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| company_name | string | 是 | 公司名称 |
| director_name | string | 是 | 董事姓名 |
| beneficiary | string | 是 | 受益人 |
| registered_cert_url | string | 是 | 公司注册证书URL |
| business_cert_url | string | 是 | 商业登记证书URL |
| director_cert_url | string | 是 | 董事证件URL |
| purpose | list<string> | 是 | 刷卡场景, 在['TIKTOK', 'FACEBOOK', 'GOOGLE', 'OTHER']中多选 |
| other_purpose | string | 否 | 特殊使用场景, 如果选有OTHER，此项必填 |
当个人注册时，以下参数必填
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| person_name | string | 是 | 姓名 |
| idcard_front_url | string | 是 | 身份证正面URL |
| idcard_back_url | string | 是 | 身份证反面URL |
| purpose | list<string> | 是 | 刷卡场景, 在['TIKTOK', 'FACEBOOK', 'GOOGLE', 'OTHER']中多选 |
| other_purpose | string | 否 | 特殊使用场景, 如果选有OTHER，此项必填 |
输出:
| 字段 | 类型 | 说明 |
|---|---|---|
| token | string | access jwt token |
重置密码
URL: POST /user/reset_password
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 是 | 邮箱 | |
| code | string | 是 | 验证码 |
| password | string | 是 | 新密码 |
输出: 无
登录
URL: POST /user/login
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 用户名，邮箱格式 |
| password | string | 是 | 密码 |
输出:
| 字段 | 类型 | 说明 |
|---|---|---|
| token | string | access jwt token |
获取用户信息
URL: GET /user/userinfo
输出: User
修改密码
URL: POST /user/change_password
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| old_password | string | 是 | 旧密码 |
| new_password | string | 是 | 新密码 |
输出: 无
获取手机验证码
测试阶段不会真发验证码，可用随意6位数验证
URL: POST /user/get_mobile_code
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| area_code | string | 是 | 手机区号 |
| mobile | string | 是 | 手机号 |
| code_type | string | 是 | 验证码类型, change_mobile |
输出: 无
修改手机号
测试阶段不会真发验证码，可用随意6位数验证
URL: POST /user/change_mobile
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| area_code | string | 是 | 手机区号 |
| mobile | string | 是 | 手机号 |
| code | string | 是 | 验证码 |
| new_area_code | string | 是 | 新手机区号 |
| new_mobile | string | 是 | 新手机号 |
输出: 无
获取邮箱验证码
测试阶段不会真发验证码，可用随意6位数验证
URL: POST /user/get_email_code
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 是 | 邮箱 | |
| code_type | string | 是 | 验证码类型, change_email, reset_password |
输出: 无
修改登录邮箱
测试阶段不会真发验证码，可用随意6位数验证
URL: POST /user/change_email
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 是 | 邮箱 | |
| code | string | 是 | 验证码 |
| new_email | string | 是 | 新邮箱 |
输出: 无