玄兵骑战 - 用户登录协议对接文档
大约 3 分钟
玄兵骑战 - 用户登录协议对接文档
文档修改记录
| 编码格式 | 密级 |
|---|---|
| utf-8 | 公开 |
| 变更时间 | 修改记录 | 版本 | 修改人 |
|---|---|---|---|
| 2017-08-24 | 新建文档 | 1.0.0 | 韩文博 |
| 2021-08-28 | 文档整理 | 1.0.0 | 朱金余 |
| 2021-09-14 | 增加loading_img字段 | 1.0.0 | 蔡力文 |
名词解释
- 游戏研发方 也称为CP,游戏的实际开发团队
- 游戏运营方 也称为游戏平台，或者叫平台方,负责连接平台用户和游戏
应用场景
对接双方的工作分工
- 游戏运营方 提供接口文档和对接参数；
- 游戏研发方 根据文档中约定的协议实现接口，调试完成后，向游戏运营方提供api接口的URL
场景介绍
- 游戏运营方，根据文档中约定的协议，组织成完整的URL，并跳转到这个URL
- 游戏研发方，校验URL中的参数后，让用户进入游戏
接口协议阐述
请求URL
- 不带参数的URL由研发向平台方提供
请求方式
- Http GET
请求参数
| 参数 | 类型 | 是否必填 | 字段释义 | 示例 |
|---|---|---|---|---|
| platform | string | 是 | 平台标识，写死51 | 51 |
| user | string | 是 | 平台用户名 | 4523616 |
| server_sn | string | 是 | 区服标识 ， 如s1,s2,s3,s4,…,sn | s6 |
| server_sn_int | string | 是 | 区服标识数字类型， 与server_sn对应，如:1,2.3,4,…,n | 6 |
| goods_sign | string | 是 | 研发方使用的游戏区服id, 如1006,平台调用研发提供的接口都会带这个参数,比如充值后发货请求 | 1006 |
| fcm | int | 是 | 实名认证标识， 0：未实名； 1：已实名且满18周岁 2：已实名但未满18周岁 | 1 |
| client | int | 是 | 客户端类型， 2:盒子; 1：微端； 0：网页 | 0 |
| time | int | 是 | 请求unixtime时间戳， 10位整数，可以依此参数判断链接的时间有效性 | 1630143222 |
| token | string | 是 | 验证token, 32位小写字符串,加密方法见文档 4.4.1 | 573aa095fe89accbe9d8b44d5de3b187 |
| payurl | string | 是 | 每个区服的充值URL, 已urlencode,使用前请urldecode | |
| qcode | string | 是 | 充值方式， 1 使用二维码（游戏内展示支付二维码）； 0 不使用二维码（充值铵钮直接跳到网页支付）， 没有对接二维码的忽略此参数 | 1 |
| loading_img | varchar(255) | 否 | 游戏load页图片名称 |
特殊参数说明
a. token的加密算法
- 注意参与加密的字段，并不是所有的字段都参与加密
- 加密算法的PHP代码如下
// 加密规则，php代码示例：
$time = time(); //获取当前的unixtime时间戳
$sec_key = ''; //加密秘钥，双方约定，一般由平台方直接给出
$token = strtolower(md5($user.$time.$server_sn.$sec_key));
注意：PHP语言中.(点)是字符串连接符，跟java语言中的+一样
b. loading_img的匹配规则
登录接口传参 loading_img: fa5bc0a11629130537b9657bea87a417
拼接出的游戏loading图片链接：http://cdn.5251yx.com/loading/fa5bc0a11629130537b9657bea87a417.jpg
返回数据（response）
- 平台不需要接口的任何返回值，研发方校验成功直接让用户进入游戏，校验失败给出友好的提示错误即可
使用说明
- time字段的用户，研发方需要根据time来判断接口是否过期，约定time值在当前时间的正负10分钟以内有效
- 关于充值方式，游戏内对接二维码扫码充值时，如果qcode=0，则不显示二维码直接跳转到平台充值