接口分析报告 - 信游XinSDK

## 信游xinsdk接口文档评估报告 ``` 接口文档地址： https://docs.qq.com/doc/DV3djSXJmeXlGYUtF ``` #### 评估审核通过 ``` 1.公共返回值 1.1）全部接口请求的返回值参数 code msg data 返回格式 JSON 2.公共错误码 2.1）cod= int 参数值 (详见具体文档) 举例 code=11代表接口请求签名错误 ``` #### 评估审核未通过 ``` 1.接口请求地址？这里具体指-我们将接口放到那个站点？ 2.接口通讯签名机制？ 3.小号进游戏需要一个接口 4.xinsdk新增功能对应游戏平台原型图 ``` #### 参数命名优化部分 ``` 1.命名规范问题： 1.1)接口请求type参数命名问题？现在有的带_有的不带举例 check_code 代表验证-验证码接口 1.2)接口文档中个别参数值命名规范问题举例: 创建小号接口 createSmall 优化：将 createSmall修改 createSmallUser 等其他参数命名问题 1.3)接口文档参数唯一性,统一个参数在所有的接口文档中不能出现2中含义举例：uname 代表账号 account 也代表账号优化：针对现在文档中参数在进行一轮参数优化，客户端与服务端技术商量出一份大家都认可的新的接口文档内容。 ``` #### 接口服务问题部分 ``` 2.1) 角色上报接口分析：请求参数缺少一个角色充值金额理由：有的游戏是往角色里面充值的，有可能角色上传游戏方支持传递 2.2) 获取三方登陆配置接口分析：请求参数缺少一个appName 三方平台名称理由：不返回这个参数无法知道appid appkey 是那个平台的配置参数 2.3) 注销登陆接口分析：请求参数将uid改成token令牌理由：登陆时候只会返回token令牌 2.4) 登陆接口分析：请求参数将uid改成token令牌理由：登陆时候只会返回token令牌，不会返回具体账号的信息 2.5) 缺少token验证接口分析：请求参数token是登陆返回的令牌理由：根据token令牌，服务端token验证成功会返回具体账号的信息 2.6) 获取登陆记录接口分析：1）这个接口是想获取当前那些账号在线吗？如果是的话token参数返回不了。分析：2）是否是当前登陆账号？这个参数如果不传当前登陆token的话服务端是不知道是不是当前登陆账号的。 2.7) 获取客服信息接口分析：返回参数缺少： [客服名称] [服务地址] 理由：建议多预留一些参数，方便以后拓展 2.8) 获取头像列表接口分析：返回参数缺少是否是默认头像字段理由：是否是默认头像用于实现自动勾选默认头像或者其他的业务场景 2.9) 小号列表接口分析：返回小号列表的时候服务端无法知道是不是当前登陆这个动作理由：小号就相当于一个角色不参与实际登陆，无法知道这个状态 2.10) 删除小号接口分析：加上一个大号的uid编号理由：因服务端需要 2.11) 游戏生成订单接口分析：加一个币种参数理由：方便拓展-举例-会不会这个游戏默认弹出的充值金额代表美元韩元日元等情况，如果没有这个情况，请忽略 ``` ### 重点问题部分 ##### 充值部分 ``` 3. 这部分是与现在的实现出入较大的部分 3.1) 游戏充值接口分析：没有理解这块传递支付类型，优惠券id,币种id拼接字符串的意思 3.2) 我的钱包接口分析：没有理解这个接口。是获取的充值站的币种吗？具体的业务是什么？ 3.3) 快速充值生成订单接口分析：这个只针对大号不针对小号是吗？ 3.4) 快速充值接口分析：这个是什么操作？充值什么呢？ 3.5) 获取充值金额接口分析：这个是什么操作？是获取这个账号的充值记录吗？还是获取支付金额?是获取某个支付方式的可以充值金额？如果是的话需要加支付方式编号 3.6)快速转账接口分析：这个是什么操作？是平台送给这个人钱吗？还是登陆的人要转给输入的对象？是的话需要传递转账人账号 ``` ##### 消息模块部分 ``` 4. 这部分是与现在的实现出入较大的部分 4.1) 获取聊天分类接口分析：没有理解聊天分类指的是? ``` ##### 下载管理模块部分 ``` 5. 这部分现在没有对应的业务 5.1) 获取应用列表接口分析：没有相关原型图无法具体分析! ``` ##### 数据中心模块部分 ``` 6. 这部分现在没有对应的业务 6.1) 上传用户在线时长接口分析：既然是在线时长怎么还有是否在线的状态参数？应该还能知道这个账号在那个设备上？那个游戏？那个游戏服？上面的在线信息！ ```