获取注册字典¶
请求参数¶
面向App,服务端使用PostgreSQL;dev/prod表示运行配置,不代表不同服务器。本只读入口可用于当前HTTPS入口的连通性探测。
八项公共请求头全部必填;X-Client-Type只能为app,平台ios/android。成功及业务错误响应设置Cache-Control:no-store,合法请求ID回传X-Request-Id。不需要Authorization。
无路径参数、查询参数和业务请求体。
请求示例¶
示例账号、凭证及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"
curl -i --fail-with-body \
-X GET "$base_url/api/v1/catalogs/registration" \
-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"
成功响应¶
HTTP 200。
{
"code": "SUCCESS",
"message": "操作成功。",
"data": {
"countries": [
{
"id": "cn",
"aliases": [
"中国",
"China",
"中国",
"중국",
"China"
]
}
],
"languages": [
{
"id": "zh",
"native": "中文 / 汉语",
"symbol": "中"
}
],
"interests": [
{
"id": "friends",
"tags": [
"meet",
"chat"
]
}
]
},
"errors": []
}
| data字段 | 类型 | 可空 | 说明 |
|---|---|---|---|
| countries | object[] | 否 | 249个国家/地区,按服务端配置的热门优先级返回,与独立国家列表顺序一致 |
| countries[].id | string | 否 | 小写2位国家代码 |
| countries[].aliases | string[] | 否 | 中文、英文、日文、韩文及英文检索别名 |
| languages | object[] | 否 | 10种资料语言,id/native/symbol均为string;保留旧格式,完整四语和顺序见独立语言目录 |
| interests | object[] | 否 | 旧6组兴趣,每组id为string、tags为string[];最多返回原108项中当前可选的代码,新建标签不进入旧协议 |
失败响应¶
| HTTP | 业务码 | 条件/处理 |
|---|---|---|
| 400 | INVALID_CLIENT_HEADERS | 元数据缺失、重复或不合法 |
| 400 | VALIDATION_FAILED / BAD_REQUEST | 请求字段、类型或JSON不符合契约 |
| 403 | FORBIDDEN | 本批仅接受app类型客户端 |
错误结构与公共协议一致;字段校验使用errors[].field/message,Accept明确不接受可用响应格式时406可无正文。示意:
{
"code": "INVALID_CLIENT_HEADERS",
"message": "对应当前请求语言的错误提示",
"data": null,
"errors": []
}
接入说明¶
示例仅截取部分词条;实际返回完整目录。国家、语言、兴趣代码与正式UI的auth_catalog.json一致。这是旧客户端兼容协议:保持原分组及代码,按服务端当前可选状态过滤,新增标签不下发到旧协议;旧客户端文字及图片仍需本地映射。新接入必须改用完整兴趣目录获取后台维护的四语名称、图标、分类、排序和启停,不能继续依赖固定素材表。
国家选择新接入使用支持的国家与地区,获得服务器显示名称、完整四语翻译、国旗地址和热门排名。本旧接口保留id/aliases字段,国家数组也采用同一热门顺序;客户端不要再按英文或代码排序。热门排名当前是服务端配置的初始优先级,不代表实时用户热度统计。
热门排序已经随国家接口部署。资料语言的新接入使用独立语言目录,读取服务端四语名称、原生名称、文字标记、搜索别名及热门排名。语言数组也共享相同热门顺序,客户端不再二次排序;当前热度为运营预设,不是实时统计。旧字典保留id/native/symbol,独立目录和保存校验由同一份语言配置生成;资料语种目录与App界面四语设置分别管理。
验证:在服务器隔离PostgreSQL上验证认证、字段校验与失败分支;验证码投递使用仅测试源码中的捕获替身,Google/Apple使用临时RSA密钥完成真实验签测试。未向真实用户发送短信/邮件,未使用真实三方应用完成端到端登录,也未代表Flutter已接入。接口实现位于Java的identity/profile/catalog/media模块;完整接入顺序见登录注册接入。