保存明信片收寄偏好¶
请求参数¶
expectedVersion:JSON非负整数必填;paused:JSON布尔值必填;language:string必填,any/zh/en/ja/ko。三个字段缺失或null均400,不是PATCH保留旧值;字符串版本或布尔强转拒绝。
请求参数按下述真实类型校验;未知JSON字段拒绝。
加密前业务对象示例:
{
"expectedVersion": 0,
"paused": true,
"language": "en"
}
JSON按AES/JWE双向加密,GET空业务信封放X-Budyoo-JWE,其他方法放加密正文;签名须绑定实际方法、路径、原始查询与受管请求头。 请求公共头强制客户端类型、平台、版本、构建、渠道、安装和请求追踪;Accept-Language支持中英日韩,未知或缺省回退英文。服务端认证身份不可由客户端字段替代。
请求示例¶
所有UUID、正文、日期和数量为合成示意。变量由统一网络层提供;安装UUID应沿用当前会话绑定,不可直接换用示例。REQUEST_JWE是按真实请求上下文生成的新密文,不是占位明文。
curl --request PATCH "$API_ORIGIN/api/v1/me/postcard-preferences" \
-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 "Content-Type: application/jose" \
--data-binary "$REQUEST_JWE"
成功响应¶
HTTP200,外层公共信封为code=SUCCESS、message按当前请求语言、errors=[]。data为Preferences,字段类型、可空性、枚举、时间与单位统一见明信片共享模型。下例仅节选关键业务字段,其余字段依共享模型返回。
{
"code": "SUCCESS",
"message": "操作成功",
"data": {
"paused": true,
"language": "en",
"version": 1
},
"errors": []
}
失败响应¶
| HTTP | code | 处理 |
|---|---|---|
| 400 | BAD_REQUEST / INVALID_CLIENT_HEADERS | 核对字段、枚举、类型和必填公共头 |
| 401 | UNAUTHORIZED | 凭证、会话或安装绑定无效 |
| 403 | FORBIDDEN / VIP_REQUIRED / ACCOUNT_DISABLED | 按角色、准入、账号或来源校验结果处理 |
| 409 | POSTCARD_CONFLICT | 核对旧版本、幂等键、暂停或当前状态条件 |
| 426 | HTTPS_REQUIRED | 使用受信HTTPS,不关闭证书验证 |
| 503 | SERVICE_UNAVAILABLE | 保留原文或草稿,核对依赖状态后重试 |
失败信封示意(message四语可变,固定code不翻译):
{
"code": "INVALID_CLIENT_HEADERS",
"message": "客户端请求信息不完整或格式不正确。",
"data": null,
"errors": []
}
精确业务失败范围以上方操作规则为准;未使用的公共错误不表示该操作新增对应副作用。JWE认证、防重放、报文限制另见加密协议。网关在业务解密前返回的413/429按入口限制处理。
接入说明¶
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验收见统一媒体交付。
暂停只阻止领取新的首信,已有往来和回信继续可用。保存立即生效并返回新版本,无需补拉。旧版本409 POSTCARD_CONFLICT。
当前UI映射、人工审核、私密范围、媒体、业务幂等与实际验证范围见明信片接入。后端接口完成不代表Flutter已接入或真机验收完成。