4.0 KiB
4.0 KiB
API 测试链路
本文件记录 docs/api-test-harness.html 内置的流程化链路。HTML 只直接执行 HTTP API;腾讯云 IM/TRTC SDK 动作作为客户端步骤列出,不伪造成后端接口。
01 三方注册/登录 -> 资料 -> 国家 -> token 生命周期
GET /healthz/ready:确认 gateway 可接流量。GET /api/v1/countries:确认注册页国家主数据可读。POST /api/v1/auth/third-party/login:使用真实 Firebase/Google ID token 登录或注册,写入 username/avatar/gender/birth/country/device/source 等注册字段。GET /api/v1/users/me/identity:确认 user_id/display_user_id 映射。GET /api/v1/users/me/overview:确认我的页聚合数据。POST /api/v1/users/me/profile/update:修改用户名、头像、生日。POST /api/v1/users/me/country/change:修改国家;同一用户一个月只允许一次,重复执行应返回冲突。POST /api/v1/auth/password/set:首次设置密码。POST /api/v1/auth/token/refresh:刷新 access token。POST /api/v1/auth/logout:失效 refresh session。
02 密码登录 -> refresh -> logout
POST /api/v1/auth/account/login:账号是当前展示短号。GET /api/v1/users/me/identity:验证登录态。POST /api/v1/auth/token/refresh:验证 refresh 轮换。POST /api/v1/auth/logout:验证 session 失效。
03 房间 -> IM -> RTC -> MicUp -> 发流确认 -> 下麦离房
POST /api/v1/rooms/create:创建房间,成功后回填room_id。POST /api/v1/rooms/join:加入业务 presence。GET /api/v1/rooms/current:确认当前可恢复房间。GET /api/v1/im/usersig:获取 IMsdk_app_id/user_id/user_sig。- 客户端 IM SDK:
TIM.create + login,房间群 ID 使用room_id。 POST /api/v1/rtc/token:获取 RTCsdk_app_id/rtc_user_id/user_sig/str_room_id。- 客户端 TRTC SDK:使用
str_room_id进房。 POST /api/v1/rooms/mic/up:麦位进入pending_publish,回填mic_session_id/room_version。- 客户端 TRTC SDK:
switchRole(anchor) + startLocalAudio。 POST /api/v1/rooms/mic/publishing/confirm:带mic_session_id/room_version/event_time_ms确认发布。GET /api/v1/rooms/snapshot:确认麦位进入publishing。POST /api/v1/rooms/heartbeat:刷新业务 presence。POST /api/v1/rooms/mic/down:下麦。POST /api/v1/rooms/leave:离房。
04 MicUp 未确认 -> publish_timeout 自动释放验证
POST /api/v1/rooms/createPOST /api/v1/rooms/joinPOST /api/v1/rtc/tokenPOST /api/v1/rooms/mic/up- 不调用
ConfirmMicPublishing,等待publish_deadline_ms或服务配置 deadline。 GET /api/v1/rooms/currentGET /api/v1/rooms/snapshot:确认麦位释放或状态转移符合publish_timeout。
05 App 消息 tab/inbox 读写链路
GET /api/v1/messages/tabsGET /api/v1/messagesPOST /api/v1/messages/{message_id}/readPOST /api/v1/messages/read-allDELETE /api/v1/messages/{message_id}
06 资源/礼物/送礼/币商转账链路
GET /api/v1/resourcesGET /api/v1/resource-groups/{group_id}GET /api/v1/giftsGET /api/v1/users/me/resourcesPOST /api/v1/users/me/resources/{resource_id}/equipPOST /api/v1/rooms/gift/sendPOST /api/v1/wallet/coin-seller/transfer
07 后台国家/区域配置链路
POST /api/v1/auth/loginGET /api/v1/auth/meGET /api/v1/admin/countriesPOST /api/v1/admin/countriesPOST /api/v1/admin/countries/{country_id}/enableGET /api/v1/admin/regionsPOST /api/v1/admin/regionsPUT /api/v1/admin/regions/{region_id}/countriesPOST /api/v1/admin/regions/{region_id}/enable
08 后台币商库存入账 -> App 币商转账
POST /api/v1/auth/loginGET /api/v1/admin/coin-sellersPOST /api/v1/admin/coin-sellers/{user_id}/stock-creditsPOST /api/v1/wallet/coin-seller/transferGET /api/v1/admin/payment/recharge-bills