GET/api/v1/me
Bearer登录凭证,需公共头JSON 响应接入指南 ↗

获取当前用户与注册进度

请求参数

面向App,服务端使用PostgreSQL;dev/prod表示运行配置,不代表不同服务器。当前公网入口使用HTTPS;仅显式启用的dev固定码HTTP例外可访问隔离开发身份。任何prod组合均关闭固定码与HTTP例外,不能靠X-Forwarded-Proto绕过。

八项公共请求头全部必填;X-Client-Type只能为app,平台ios/android。成功及业务错误响应设置Cache-Control:no-store,合法请求ID回传X-Request-Id。另须 Authorization: Bearer <accessToken>,安装ID必须与会话一致。

无路径参数、查询参数和业务请求体。

请求示例

示例账号、凭证及UUID为合成数据。当前唯一正式部署环境处于上线前阶段,dev运行配置下手机号和邮箱统一使用123456,仍须先申请challengeId,不发送短信或邮件。公网HTTPS已验收;真实发送供应商及正式开放前的配置检查仍待完成。

base_url='https://api.budyoo.cn' # 当前正式域名;上线前阶段使用隔离开发身份
device_id='4d4ae3ea-6a4a-4f34-a292-8e94551851d7' # 同一安装持久保存
request_id=$(uuidgen | tr '[:upper:]' '[:lower:]')
timestamp="$(date +%s)000"
access_token='替换为实际accessToken'
curl -i --fail-with-body \
  -X GET "$base_url/api/v1/me" \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN' \
  -H 'X-Client-Type: app' \
  -H 'X-Platform: android' \
  -H 'X-App-Version: 1.0.0' \
  -H 'X-App-Build: 1' \
  -H 'X-Channel: dev' \
  -H "X-Device-Id: $device_id" \
  -H "X-Request-Id: $request_id" \
  -H "X-Request-Timestamp: $timestamp" \
  -H "Authorization: Bearer $access_token"

成功响应

HTTP 200。

{
  "code": "SUCCESS",
  "message": "操作成功。",
  "data": {
    "userId": "11111111-1111-4111-8111-111111111111",
    "registrationStatus": "INCOMPLETE",
    "nextStep": "COUNTRY",
    "registrationStep": 1,
    "vipGateEnabled": false,
    "vipActive": false,
    "vipRequired": false,
    "country": null,
    "nickname": null,
    "gender": null,
    "birthday": null,
    "spokenLanguage": null,
    "learningLanguage": null,
    "introduction": null,
    "avatarId": null,
    "interests": [],
    "completionPercent": 0,
    "moderation": {
      "avatar": {
        "status": "EMPTY",
        "reviewId": null,
        "reason": null,
        "submittedAt": null,
        "reviewedAt": null
      },
      "nickname": {
        "status": "EMPTY",
        "reviewId": null,
        "reason": null,
        "submittedAt": null,
        "reviewedAt": null
      },
      "introduction": {
        "status": "EMPTY",
        "reviewId": null,
        "reason": null,
        "submittedAt": null,
        "reviewedAt": null
      },
      "published": {
        "avatarId": null,
        "nickname": null,
        "introduction": null
      }
    }
  },
  "errors": []
}
data字段 类型 可空 说明
userId string(UUID) 否 当前账号编号
completionPercent integer 否 后端按已保存本人资料计算的0–100整数百分比,只读,不带百分号;规则见资料完善度
registrationStatus string 否 INCOMPLETE 或 COMPLETE
nextStep string 否 COUNTRY、PROFILE、INTRO、INTERESTS、COMPLETE_REGISTRATION 或 HOME,保留原导航语义
registrationStep integer 否 仅1–4:1国家、2资料、3语言生日介绍、4兴趣;完成后仍为4,由registrationStatus区分
vipGateEnabled boolean 否 当前会话发行渠道的第二层VIP准入开关,动态读取,默认false
vipActive boolean 否 服务端确认的有效VIP权益;未付款、过期或撤销为false
vipRequired boolean 否 资料完成且开关开启、无有效VIP时为true,需进入VIP页
country string 是 国家目录代码
nickname string 是 昵称,新写入1–8个UTF-16代码单元;历史昵称按原值返回
gender string 是 male 或 female
birthday string(date) 是 YYYY-MM-DD
spokenLanguage string 是 我会的语言代码
learningLanguage string 是 学习语言代码
introduction string 是 个人介绍,最多30个UTF-16代码单元
avatarId string(UUID) 是 本人已上传头像编号
interests string[] 否 兴趣代码,返回按代码升序,无选择为[]

失败响应

HTTP 业务码 条件/处理
400 INVALID_APP_CHANNEL 渠道未知、平台不匹配或prod误用dev,不能当关闭VIP门槛
400 INVALID_CLIENT_HEADERS 元数据缺失、重复或不合法
400 VALIDATION_FAILED / BAD_REQUEST 请求字段、类型或JSON不符合契约
403 FORBIDDEN 本批仅接受app类型客户端
503 SERVICE_UNAVAILABLE 当前渠道VIP策略缺失或数据库暂不可用;不按关闭门槛放行
426 HTTPS_REQUIRED 敏感接口要求HTTPS
401 UNAUTHORIZED 未登录、凭证失效或设备不匹配

错误结构与公共协议一致;字段校验使用errors[].field/message,Accept明确不接受可用响应格式时406可无正文。示意:

{
  "code": "UNAUTHORIZED",
  "message": "对应当前请求语言的错误提示",
  "data": null,
  "errors": []
}

接入说明

2026-11-20统一媒体交付已部署到唯一正式环境(运行配置仍为dev):已认证App成功响应自动替换受支持用户媒体URL并按需附加顶层mediaDelivery,不再要求能力头;无头、cdn-v1和oss-v1均使用同一结构。服务端选择CDN/OSS/API,客户端按transport加载;原ID、版本、权限、JWE与JSON的no-store保持。非空avatarId及albumPhotoIds按统一规则补充avatarUrl/albumPhotos,单项媒体依赖失败不推翻已提交业务。完整字段、缓存与Flutter验收见统一媒体交付。

本响应直接带回data.completionPercent,前端使用服务端分数,不再按字段数量自行均分,不需要新增请求。本页成功示例按无已绑定相册计算,相册存在性由服务端读取,无需客户端补拉相册。

新增moderation对象,三项avatar/nickname/introduction分别返回status、reviewId、reason、submittedAt及reviewedAt,另有published保存当前实际公开值。类型、可空范围、状态和示例见逐项资料审核。本人响应的原头像、昵称、签名继续表示本人提交内容;保存或注册完成只表示自动进入审核,公开页面只取最后通过值,首次无通过值使用默认头像/四语默认昵称/空签名。审核不新增注册步骤、不改变渠道VIP,其他字段或无变化保存不重复提审;清空头像或签名立即撤下。

「我的」首屏统一使用主页汇总一次读取资料、所选目录名称和统计,不应先读本接口再并发读取关系、钱包及两个分页总数。本接口继续用于其他只需本人资料/注册状态的场景,字段和路径保持兼容。

VIP开关按发行渠道独立读取,沿用既有X-Channel/X-Platform及三个VIP布尔字段。登录绑定会话渠道,访问和刷新须一致;历史NULL会话首次合法使用绑定,之后改头返回401。首次注册来源字段只做归因,不决定当前会话门槛。详见渠道与VIP准入。

两层跳转与支付边界见注册资料与VIP准入:先完成资料,再判断vipRequired;COMPLETE或nextStep=HOME单独都不足以跳过开启的VIP门槛。渠道开关独立配置(首次初始化默认关闭,升级保留原值),客户端不能自行提交付款成功来获得权益。

步骤对应与重登恢复流程见登录注册步骤说明。每次保存资料成功后由服务端同步落库,登录直接返回registrationStep供前端跳转,无需增加或调用单独进度接口;现有刷新和本人资料也返回同一字段,客户端不提交步骤。第4步及已完成用户均返回4,registrationStatus=COMPLETE后还须判断vipRequired:true进入VIP页,false才进入首页。

INCOMPLETE用户仅有注册、头像及会话权限;后续普通业务要求注册完成。registrationStep在用户记录持久化;nextStep保留根据已保存资料推导的导航语义:国家→昵称/性别→生日/语言/介绍→兴趣→完成注册。COMPLETE后步骤仍为4、nextStep为HOME。VIP引导由客户端展示,会员权益和第二层准入由VIP规则说明,实际支付渠道尚未接入。接口不返回手机号、邮箱或三方凭据。

验证:在服务器隔离PostgreSQL上验证认证、字段校验与失败分支;验证码投递使用仅测试源码中的捕获替身,Google/Apple使用临时RSA密钥完成真实验签测试。未向真实用户发送短信/邮件,未使用真实三方应用完成端到端登录,也未代表Flutter已接入。接口实现位于Java的identity/profile/catalog/media模块;完整接入顺序见登录注册接入。

验证范围

2026-11-06服务器隔离PostgreSQL/Redis的clean verify共763项全部通过,新增25项覆盖十项权重、空白与空列表、注册保存/完成、本人资料/主页/编辑读取与保存一致性、媒体暂存与绑定/清空、待审资料、并发读取快照、客户端只读字段、失败不改变分数、四语与英文回退,以及原鉴权/安装/公共头/VIP准入;接口用例通过真实HTTP控制器与JWE认证解密。仅操作隔离合成账号;运行环境的已登录资料和客户端/设备显示未在本次操作,Flutter需接入服务端completionPercent。