术语表
本文描述合作方接入世游 Hub 平台时,需要理解的核心概念与术语。
合作方
Partner
与世游建立合作关系的外部平台,如虎牙、小黑盒、微博 等。
每个 Partner 由世游侧在管理后台创建和管理。
Partner ID
由世游侧为合作方分配的唯一标识,是一个字符串。
合作方在调用 Hub API 时,需要在签名认证的 Authorization header 中携带 Partner ID。
Partner ID 示例:huya。
Secret Key
由世游侧为合作方分配的密钥,用于合作方调用 Hub API 时的签名认证。
Secret Key 应当被当作秘密对待,仅存储在合作方的服务器上,严格控制访问权限,不应以任何形式暴露给客户端。
Partner User ID
合作方平台上的用户唯一标识。由合作方定义,世游侧不关心其具体格式,仅要求在同一合作方内唯一。
Partner User ID 示例:user_98765432。
游戏与角色
Game ID
由世游侧为每款游戏分配的唯一标识,是一个字符串。
合作方在接入时会获得其有权限对接的 Game ID 列表。
Game ID 示例:ggd。
Server ID
游戏中的服务器 ID,用于标识玩家所在的服务器。
Role ID
游戏中的角色 ID,用于唯一标识一个游戏角色。
一个绑定关系最终绑定到的是一个具体的游戏角色(由 Game ID + Server ID + Role ID 唯一确定)。
绑定
Binding
绑定关系是指合作方用户(Partner User ID)与游戏角色(Role ID)之间的关联,是一对一关系。
关于绑定模型与换绑规则,详见 绑定概述。
Rebind Policy
换绑策略,用于控制用户重新绑定新角色的行为,取值为 unlimited(允许换绑)、forbidden(禁止换绑)、cooldown(冷却期换绑)。由世游侧为每个合作方配置,详见 换绑机制。
Bind Token
合作方通过调用 获取绑定链接 接口获得的一次性绑定令牌。用户携带此令牌跳转到世游通行证页面完成绑定操作。
Bind Token 为一次性令牌:有效期以 获取绑定链接 返回的 expires_in 为准,绑定成功后立即失效。
Redirect URL
合作方在发起绑定请求时提供的回调地址。用户在世游通行证页面完成绑定后,将被重定向至此地址。支持非 HTTP 协议(如 App 的 Scheme 协议),例如 douyin://some/path。
关于重定向的具体行为,参见 绑定流程。
活动与奖励
Event
活动是由世游运营人员在管理后台创建的,具有特定时间窗口的运营活动实体。每个活动关联一个或多个奖励包。
合作方发放奖励时,需要指定世游侧提供的 event_id。
Reward Bundle
礼包是一组游戏道具的集合,由世游运营人员在管理后台配置。每个奖励包包含若干道具及其数量,有独立的每角色领取上限。
合作方发放奖励时,需要指定世游侧提供的 reward_bundle_id。
Partner Grant Reward ID
合作方在调用 发放奖励 接口时提供的奖励发放唯一标识。用于保证同一笔奖励不会被重复发放。
合作方需要保证 partner_grant_reward_id 全局唯一,至少要保证在同一游戏下唯一。若使用相同的 partner_grant_reward_id 重复调用,不会重复发放。