GET/api/v1/community/catalog
ROLE_USER,Bearer,资料完成及VIP准入,完整App公共头JSON 响应接入指南 ↗

读取互动目录与发布限制

请求参数

无路径、查询或业务正文。

要求服务端认证的ROLE_USER、资料完成和动态VIP准入。Bearer与安装ID绑定。 公共请求头强制校验客户端类型、平台、版本、构建、渠道、安装和请求追踪;Accept-Language支持中英日韩,未知回退英文。 JSON使用AES/JWE:GET的空业务正文信封置X-Budyoo-JWE,其他方法放密文正文。正式要求HTTPS;开发HTTP仅按隔离账号兼容契约。

请求示例

以下UUID、昵称、时间和数值均为合成示意;按加密协议对实际路径、查询串和本次头生成信封,不能直接发送占位密文。变量由统一网络层提供,切勿关闭TLS校验。

curl --request GET "$API_ORIGIN/api/v1/community/catalog" \
  -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: google_play" \
  -H "X-Device-Id: 33333333-3333-4333-8333-333333333333" \
  -H "X-Request-Id: $REQUEST_UUID" \
  -H "X-Request-Timestamp: $NOW_MILLIS" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Budyoo-Encryption: jwe-v1" \
  -H "Accept: application/jose" \
  -H "X-Budyoo-JWE: $REQUEST_JWE"

成功响应

HTTP200;外层公共信封为code=SUCCESS、message当前请求语言、errors=[]。data为Catalog;每个字段的类型、可空性、枚举和单位见互动共享模型的“话题与目录”。

{
  "code": "SUCCESS",
  "message": "操作成功",
  "data": {
    "categories": [
      {
        "id": "daily",
        "name": "日常"
      },
      {
        "id": "travel",
        "name": "旅行"
      },
      {
        "id": "food",
        "name": "美食"
      },
      {
        "id": "language",
        "name": "语言交流"
      },
      {
        "id": "hobbies",
        "name": "兴趣"
      }
    ],
    "interests": [
      {
        "id": "travel",
        "name": "旅行"
      },
      {
        "id": "cafe",
        "name": "咖啡日常"
      },
      {
        "id": "language",
        "name": "语言交流"
      }
    ],
    "dailyTopic": null,
    "topicLimit": 2,
    "contentLimit": 1000,
    "commentLimit": 300,
    "translationAvailable": false
  },
  "errors": []
}

失败响应

HTTP code 处理
400 BAD_REQUEST / INVALID_CLIENT_HEADERS 参数、类型、长度、枚举或公共头错误
401 UNAUTHORIZED 身份无效、过期或安装不匹配
403 FORBIDDEN / VIP_REQUIRED / ACCOUNT_DISABLED 注册资料未完成、VIP准入或账号不允许;其他账号/设备限制按公共安全协议处理
404 NOT_FOUND 对象不存在、删除、未审核不可见、屏蔽或归属错误
426 HTTPS_REQUIRED 按正式协议使用HTTPS;开发例外以公共契约为准
503 SERVICE_UNAVAILABLE 依赖不可用,保留本地状态并稍后重试

公共JWE错误、请求过大和入口限流另见加密协议及入口限制。四语message可变,固定code不翻译;网关在JWE之前拒绝时不能将普通JSON当已认证业务响应。

接入说明

全部界面标签按Accept-Language选择四语,未知回退英文。dailyTopic允许null。translationAvailable仅表示存在可尝试配置。

完整状态机、共享字段、媒体限制及UI调用顺序见互动与审核接入。2026-11-05随本次470项服务器全量回归通过并部署;具体隔离与线上覆盖见共享接入页“验证范围”。Flutter真机和真实翻译供应商仍须各自接入验收。