退出登录¶
请求参数¶
面向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 POST "$base_url/api/v1/auth/logout" \
-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" \
-H 'Content-Type: application/json' \
--data '{}'
成功响应¶
HTTP 200。
{
"code": "SUCCESS",
"message": "操作成功。",
"data": null,
"errors": []
}
data固定为null,errors为[]。
失败响应¶
| HTTP | 业务码 | 条件/处理 |
|---|---|---|
| 400 | INVALID_CLIENT_HEADERS | 元数据缺失、重复或不合法 |
| 400 | VALIDATION_FAILED / BAD_REQUEST | 请求字段、类型或JSON不符合契约 |
| 403 | FORBIDDEN | 本批仅接受app类型客户端 |
| 426 | HTTPS_REQUIRED | 敏感接口要求HTTPS |
| 401 | UNAUTHORIZED | 未登录、凭证失效或设备不匹配 |
错误结构与公共协议一致;字段校验使用errors[].field/message,Accept明确不接受可用响应格式时406可无正文。示意:
{
"code": "UNAUTHORIZED",
"message": "对应当前请求语言的错误提示",
"data": null,
"errors": []
}
接入说明¶
撤销当前账号唯一会话的全部访问/刷新凭证。成功后客户端清除本次会话的安全存储;重复携带已经失效的凭证会返回401,客户端可视为已经退出。此处撤销的是HTTP会话,实时连接的即时断连传播需单独联动。
验证:在服务器隔离PostgreSQL上验证认证、字段校验与失败分支;验证码投递使用仅测试源码中的捕获替身,Google/Apple使用临时RSA密钥完成真实验签测试。未向真实用户发送短信/邮件,未使用真实三方应用完成端到端登录,也未代表Flutter已接入。接口实现位于Java的identity/profile/catalog/media模块;完整接入顺序见登录注册接入。