【弹幕玩法】技术接口总文档
| 更新记录 | |
| 更新时间 | 更新内容 |
| 2024.03 | 新增了可操作能力和内购礼物能力，支持用户下场操作获得更深度的玩法体验，支持对局消费以外的消费场景，此部分开发者将有更高的分成收益 |
# 一、技术接入
更新时间：2024-08-05 21:48:30
基础能力：上线必备能力（不接则不能上线）
产品扩展能力：产品功能能力，包含快捷评论、底部栏、可操作等产品能力
通用能力：通用的扩展能力
# 二、整体接入实现文档
# 2.0接入指引
快手弹幕玩法CP技术选型指引 (opens new window)
# 接口总览文档（如遇未知接口，可以在文档中查询快速定位）
【弹幕玩法】技术接口-总览&快速查询 (opens new window)
# 2.1 基础能力（上线必须接入）
| 类型 | 核心需求 | 相关文档 | 功能截图 |
主播链路
| 绑定相关 | 直播弹幕玩法技术基础能力接口文档-对外 |   |
| 对局相关 | |||
| 置顶礼物 | |||
| 推送互动消息（用户点赞、评论、送礼、关注、分享、加入粉丝团、开通续费超粉团、开通续费贵族） | |||
| 对用户头像图片进行缩放 | 用户头像图片处理能力 |  | |
| 推送消息回查 | 【弹幕玩法】加固能力技术接口文档-对外 | 无 | |
| cp客户端收到消息ack接口 | |||
| cp客户端展示消息ack接口 |
# 2.2 产品扩展能力（产品功能）
| 类型 | 核心需求 | 相关文档 | 功能截图 |
| 用户链路 | 快捷评论，用户点击按钮加入战队 | 【弹幕玩法】快捷加入战队组件开发者接入文档 |  |
| 礼物效果提示 | 【弹幕玩法】礼物效果提示信息开发者接入文档 |  | |
| 弹幕底部栏小程序&内购礼物接入介绍 | 【弹幕玩法】底部栏面板小玩法引擎接入 |  | |
主播链路
| 主播一键开播，自动连接 | 【开放能力】PC伴侣开播链路优化（自动传参） |   |
| 主播连屏，目前支持两个直播间的连屏功，增加相应的主播社交联系等，现有使用场景：主播pk，主播合作等 | 快手直播弹幕玩法主播双人连屏文档 |  | |
| 小摇杆 | 云可操作用户可操作接入介绍 | 快手直播弹幕玩法可操作接入文档 |  |
| 小程序可操作 |
# 2.3 通用能力
| 类型 | 核心需求 | 相关文档 | 功能截图 |
| 用户反查 | 根据用户id查询openId 获取直播间信息 | 【弹幕玩法】排查能力技术接口文档-对外 | 无 |
| 用户信息查询 | 用户间内基础信息、粉丝团、贵族、用户等级，用户排名等信息查询 | 小玩法间内用户数据开放开发者接入文档 | 无 |
| 云开播 | 支持移动端，pc开播 | 快手小玩法云化接入指引 |  |
| 云支付 | 支持玩法内送礼，用户点击三方玩法客户端，通过服务端对接平台服务端送礼。例：用户下场后，边玩边送礼 | 【统一支付】小玩法内道具送礼接口-云支付 |
 
|
| 组队语音 | 支持直播间内组队语音能力，频道控制、麦位管理 | 【小玩法】实时语音开发者接入文档 | 暂无 |
| 游戏帧数据同步 | 将游戏帧和游戏快照，通过平台长链接推送给小程序观战用户 | 直播弹幕玩法-游戏数据同步能力接口文档-对外 | 暂无 |
| 压测 | 压测点赞、送礼、评论 | 【小玩法】压测方法 | 暂无 |
2.4 安全防护
| 类型 | 核心需求 | 相关文档 | 功能截图 |
| 安全防护 | ddos安全防护 | ddos防护指南 |
# 三、客户端接入：
| 客户端接入 | 快手弹幕玩法客户端接入说明 | 上线必须接入 |
| 链路优化 | 【开放能力】PC伴侣开播链路优化（自动传参） | 上线必须接入 |
# 四、服务性能和稳定性要求
# 4.1上线前需要提供接口压测信息
单玩法预计能承担直播间内评论600qps、点赞qps 3000、送礼qps 600（1：5：1）
服务端聚合后：
单直播间：需要支持 max 1000 qps （评论1000，点赞1qps（聚合了1s内的1000条点赞）1qps，送礼20qps (单条聚合了50ms内所有送礼消息，每次25条))
全局压测：全局需要支持 4200 qps ，评论：点赞：送礼 = 1：5：1
策略： 压测流量等比例缩放
客户端：在以上标准上，10分钟，不发生崩溃，fps 18以上
数据规模：对战类玩法支持单场5w UV 用户参与
推送接口P995<1000ms
# 4.2上线前客户端要求
机器：i5 10400f + 3060
帧率 >18
卡帧率 < 30%
上线前需要通过性能检验
# 4.3监控要求
cp服务应该具备完善的多维度监控，包括但不限制于
主播在线数监控、掉量报警
推送数据同环比&&报警
快手侧接口失败报警
基础组件可用性报警
以及其他业务异常错误报警
# 4.4降级要求
限流策略
核心流程可降级（按照自己业务设计）
# 五、线上变更机制
# 5.1上线时间
周一到周四，上午十点到十二点，下午两点到六点
周五尽量不要上线
周末禁止上线
# 5.2上线要求
cp侧功能更新，要求
可监控
可灰度/可放量（1% -> 10% -> 30% -> 60%-> 100%）
可回滚
出现问题可以快速关闭开关回滚，降低故障影响时间
禁止热更新，绕过平台审核机制！！！！
如果出现问题，无法及时止损的，平台会下线小游戏，修复后测试重新走放量流程
5.3通报机制
功能开发前与产品沟通
服务上线时在群中进行通报
新业务上线放量时cp在KIM群里（早上10点~晚上10点）每间隔4小时(10点 14点 18点 22点)发布一次巡检信息
# 5.4oncall机制
对接群中主要开发人员和产品备注加电话，方便紧急联系，周末紧急联系人要能保证接听电话防止有故障
# 六、文档
# 6.1故障报告模板
# 6.2版本更新日志（复制使用）
XXX弹幕玩法更新日志 (opens new window)