应用接入文档

Transcription

1 掌趣安卓应用接入文档 修订记录 日期 SDK 主版本 修改说明 作者 V3.0.0 创建初始文档 施平 V3.0.0 完成初始文档 孟令一 王智超 刘岩 吴立刚等 V 修改 设置角色信息接口, 孟令一 此接口内增加了游戏角色注册日志和角色登录日志的发送, 因此游戏不再需要发送角色注册和登录日志 2. 去掉了 日志发送接口对角色注册和角色登录日志的说明 V3.0.1 针对发货通知接口, 补充了注意事 刘岩 项, 包括 actualprice propunit 的含义 V 检查 APK 更新功能 : 当用户网络为 2G/3G 网络提示用户是否下载 APK 孟令一 李庆硕 1 应用接入文档 北京掌趣科技股份有限公司

2 2. 修改登录注册等接口返回的提示 语 V3.0.2 针对发货通知接口, 当 delivercode 返回 0001 时, 不 需要在该消息中传递 optional, 删 除了 optional V 为了对之前接口形式的登录等 功能的支持, 增加了 Ourpalm_Login_SupportPre Api(String name, String pwd) 接口, 游戏可以将保存在游戏中的用户名和密码传进 SDK 的登录界面, 方便用户登录 2. 精简整理日志输出 V SDK 内部优化 2. 修改用户中心 webview 页面输入框被软键盘遮挡的 BUG 3. 接口无变化 施平 V3.0.4 更新了附录中的语言规范施平 V3.0.4 加入计费中心 IP 地址鉴权需求刘海峰 李庆硕, 孟令一 孟令一, 李庆硕 V 发货通知接口加入编码要求 2. 发货回调接口加入编码要求 V 修改 SDK 初始化接口, 增加游 戏类型参数 publicstaticfinal String GameType_Online = "1"; // 网 游 publicstaticfinal String GameType_Console = "2"; // 单机 2.SDK 内部优化, 增加对单机游 戏的功能支持 3. 自有支付增加短信支付功能, 主要用于单机游戏 4. 增加并修改部分文字提示, ourpalm_strings.xml 中 制 5. 修改官网登录对用户名的限 6. 增加游戏启动日志 7. 其他修改 胡高勇 孟令一, 李庆硕, 李光才, 刘利男 2 应用接入文档 北京掌趣科技股份有限公司

3 V 修改了更新提示框和登录提示框冲突的 BUG 2. 自有支付增加微信支付 3. 其他优化 V3.0.7 修改支付接口增加商品数量, 虚拟 货币单位, 虚拟货币数量 V 增加 4.4 版本命名要求 2. 更新附录 4 货币及语言信息 V3.0.7 补充登入验证接口中各地域的地址 清单 ; V3.0.7 接入流程的 3.9 中补充了版本命名 要求的引用 V 优化支付接口 2. 为单机 3 网 SDK 增加订单信息同步 功能 3. 增加获取业务 ID, 渠道 ID, 机型 组 ID, 语言 ID 的接口方法 4. 其他 BUG 修改及优化 V 增加排行榜相关功能接口 ( 网游 暂不需要, 不做详细描述 ) V 增加接口 onnewintent 目前为 微信登录提供 V 发货通知接口请求参数说明中 chargeprice 和 actualprice 类型改 为 String V 修改支付接口, 去掉参数虚拟物 品单位 (ID) 和虚拟物品数量, 原 来的支付接口已被设置为过时接 口, 能使用, 但不建议使用, 新接 入 SDK 的游戏一定不要使用 2. 优化获取渠道 ID 3. 增加 Ourpalm_onNewIntent 方 法, 游戏必须调用 4. 优化官网支付 V 增加活动公告相关接口 2. 增加排行榜相关接口 3. 增加礼包码兑换接口 V 增加渠道方 LOGO 展示页面 2. 增加一套注册流程 3. 增加签名验证功能, 主要防止单 机游戏破解 李庆硕, 孟令一李庆硕, 李光才施平李双迎施平孟令一刘利男刘利男宋文彬孟令一, 李庆硕, 李光才刘利男, 李庆硕孟令一, 李庆硕, 李光才, 刘利男 3 应用接入文档 北京掌趣科技股份有限公司

4 4. 其他修改与优化 V 修改优化用户登录系统 2. 单机隐式登录成功后增加角色日 孟令一, 李庆硕, 李光才, 刘利男 志的发送 3. 防破解功能优化 4. 修改 LOGO 图片的显示方式 5. 增加分享接口, Ourpalm_GoSnsShare, 第三方渠道如有分享功能请调用此接口 6. 其他修改与优化 V3.1.3 加入接入必读 删除附录, 更新发 施平 王智超 货接口参数 V 优化 SDK 的启动速度 孟令一 2. 增加是否允许打开声音的接口 3. 其他修改与优化 V InterfaceId 参数第一个字母改 宋文彬 成小写 V 增加客服反馈接口 2. 优化掌趣官网用户系统流程 李光才 李庆硕 刘利男 孟令一 3. 增加礼包码兑换功能的错误提示 4. 联网初始化过程中增加签名验证功能 5. 修改部分提示框的 UI 6. 优化修改好友排行榜等功能 7. 其他修改与优化 V 修改文档登陆失败回调说明 李光才 李庆硕 刘利男 孟令一 V 修改用户中心等提示语文字 2. 增加 DEBUG 日志发送功能 孟令一, 李庆硕, 刘利男, 李光才 3. 修改客服问题反馈功能的 UI 和其他修改与优化 4. 修改 SDK 部分 UI 5. 增加移动卡的判断条件 6. 增加限制玩家进入游戏和充值的功能 7. 好友功能增加获取得奖名单接口 8. 其他修改与优化 V 增加捕获系统崩溃日志功能 2. 网游支付接口增加角色等级和角 孟令一, 李庆硕, 李光才, 刘利男 4 应用接入文档 北京掌趣科技股份有限公司

5 色 VIP 等级 2 个参数 3. 优化用户反馈功能 4. 优化统计功能 5. 优化支付逻辑判断 6. 增加调用账号注销接口 7. 其他修改与优化 5 应用接入文档 北京掌趣科技股份有限公司

6 目录 修订记录... 1 目录 文档说明 功能描述 阅读对象 接入必读 接入准备 版本命名 帮助信息 服务端注意事项 SDK 构成 开发环境搭建 资源和 lib 库的引入 AndroidManifest.xml 的配置 备注说明 登录/注册流程 流程说明 接口介绍 SDK 初始化 客户端调用 必须 登录 客户端调用 必须 登录 客户端调用 可选 为兼容官网老版本接口形式 登录注销 客户端调用 可选 根据要求调用 切换账号 客户端调用 可选 根据要求调用 登录成功并进入游戏后 设置角色的注册和登录信息 客户端调用 必须 登录验证 服务器调用 可选 充值/发货流程 流程说明 接口介绍 支付接口 客户端调用 必须 发货通知接口 服务器调用 必须 发货回调接口 服务器调用 必须...错误 未定义书签 7. 日志接入流程 其它功能接口 Activity 生命周期方法的调用 客户端调用 必须 获取可选接口中的可用接口 客户端调用 必须 进入用户中心 或论坛 接口 客户端调用 可选 根据要求调用 退出游戏接口 客户端调用 必须 应用接入文档 北京掌趣科技股份有限公司

7 8.5. 开启 SDK 日志输出 客户端调用 可选 获取业务 ID 客户端调用 可选 获取渠道 ID 客户端调用 可选 获取机型组 ID 客户端调用 可选 获取语言 ID 客户端调用 可选 查询排行榜是否有活动接口 客户端调用 可选 打开排行榜积分榜页面接口 客户端调用 可选 排行榜积分操作接口 客户端调用 可选 打开排行榜活动公告页面 客户端调用 可选 查询当前是否有新活动公告 打开活动公告页面 礼包码兑换接口 分享接口(客户端调用 可选) 客服反馈接口(客户端调用 可选) 应用接入文档 北京掌趣科技股份有限公司

8 1. 文档说明 1.1. 功能描述 此文档主要是用于在游戏及应用开发商需要接入掌趣 SDK 时, 各个用户和计费相关的接口参考说明 1.2. 阅读对象 接入掌趣的游戏及应用开发者, 包括客户端及服务器工程师 2. 接入必读! 接入 SDK 前, 请务必认证阅读以下须知 2.1. 接入准备 接入开始前, 请先做好如下准备工 : 1. 创建游戏, 获取渠道参数及配置文件接入前, 需要由掌趣项目负责人完成渠道申报并在掌趣后台进行配置, 从而获取到该游戏的渠道参数 掌趣配置文件 ( 见下图 ) 掌趣配置文件 (ourpalm.cfg) 按照渠道及语言机型的不同, 被分别打到对应的压缩文件目录中 注意 : 接入前, 务必将 SDK 包中 assets 目录下 ourpalm.cfg 替换为对应渠道配置文件中的 ourpalm.cfg, 否则很可能会报错 2. 提供游戏服信息, 填写游戏分服列表计费测试前, 需要在掌趣后台配置相应的游戏服信息, 请填写 游戏分服列表 ( 格式如下 ), 并提交给掌趣项目负责人进行配置 8 应用接入文档 北京掌趣科技股份有限公司

9 3. 完成计费申报, 填写商品录入模板计费测试前, 还需要完成在渠道的计费点申报, 填写 商品录入模板 ( 见下图 ), 并由掌趣项目负责人完成在掌趣后台的配置 2.2. 版本命名 游戏版本命名 ( 安卓是指 androidmainfest.xml 中的 versionname,ios 是指 info.plist 中的 Bundle version), 必须遵循如下规则要求 ( 详见 1. 版本信息不能出现数字和小数点之外的字符, 以小数点进行分割, 分隔后每个 分区只有一位的情况可以是零, 如果是多位则首位必须是非零, 正确格式如 , 非法格式如 不能有横杠 (58390) 不能出现括号 1.0.a 不能带字母 多位数字首位不能为 0 2. 版本信息从左到右按照每个分区转为 Integer 进行比较, 如 > (1 > 0) < (9 <10) < (11<101) 3. 后续版本信息不允许增加小数点, 如 : 9 应用接入文档 北京掌趣科技股份有限公司

10 1.0 版本上线后, 后续版本不可以出现 1.0.1, 否则会按非法版本号处理, 将会强制提示更新 1.0 版本 2.3. 帮助信息 接入过程中, 可访问掌趣 SDK 官网 ( 上获得最新的帮助信息及文档, 包括 : 客户端错误码, 计费中心错误码, 用户中心错误码, 货币类型及对应 ID, 服务端注意事项 1. 用户中心 ID 区分大小写掌趣用户中心的用户 ID, 作为用户账号的唯一标识, 区分大小写, 相同字母和数字 大小不同的用户 ID 代表的是两个不同的用户账号 因此, 游戏在使用和存储掌趣用户 ID 时, 务必要严格区分大小写, 以免造成游戏内账号和角色的混乱等问题 如果游戏有自己的用户 ID, 必须和掌趣用户中心的用户 ID 一一对应, 不得出现一对多或者多对一的情况 也不得根据其他条件, 组合生成新的用户 ID, 否则将会出现账号丢失的情况 2.5 特别说明 1. 渠道信息在掌趣自动打包系统里,serviceId 是区分渠道信息的标识, 研发如果要获取渠道信息, 请调用获取 serviceid 的接口 ( 详见接口 2.3.3), 并和技术经理匹配各 serviceid 对应的渠道 2. 是否接入第三方 SDK 如果产品接入了第三方 SDK, 有需要根据包名 签名分配参数的情况, 一定要提前通知技术经理 各个渠道包的包名 签名 证书等都不一样 自动打包将替换客户端包名 签名和证书 但不会自动替换第三方的参数 如地图 语音 推送能功能的第三方 SDK 具体如何实现, 需要根据具体情况操作 3. SDK 构成 10 应用接入文档 北京掌趣科技股份有限公司

11 4. 开发环境搭建 4.1. 资源和 lib 库的引入 方式一 : 游戏工程直接引用 <Ourpalm_Android_SDK_Lib_ 渠道缩写 _ 完整版本号 > 此 lib 工程, 工程内已包含 res 中的资源和 lib 库, 如还需使用 assets 中资源, 请自行从 < 资源,LIB 库和配置文件 > 中复制 assets 文件夹中内容到游戏工程 如何引用 LIB 工程这里不做详细说明, 如不清楚如何导入 LIB 工程到游戏工程请上网搜索, 或者咨询掌趣 SDK 技术人员 方式二 : 直接从 < 资源,LIB 库和配置文件 > 中复制所有资源和 lib 库到游戏工程的相应目录, 包含 res,libs,assets 注意 : 由 MIS 平台获取的 ourpalm.cfg 请放到 APK 的 assets 文件夹的根目录 11 应用接入文档 北京掌趣科技股份有限公司

12 4.2. AndroidManifest.xml 的配置 请游戏直接从 < 资源,LIB 库和配置文件 > 中 AndroidManifest.xml 中复制当前渠道所需配置的内容, 内有详细的注释说明 如不清楚请咨询掌趣 SDK 技术人员 1. 掌趣 SDK 所需要的权限 : <!-- OurpalmSDK 需要的权限 --> <uses-permission android:name="android.permission.access_network_state"/> <uses-permission android:name="android.permission.access_wifi_state"/> <uses-permission android:name="android.permission.change_network_state"/> <uses-permission android:name="android.permission.change_wifi_state"/> <uses-permissionandroid:name="android.permission.internet"/> <uses-permission android:name="android.permission.read_phone_state"/> <uses-permission android:name="android.permission.write_external_storage"/> <uses-permission android:name="android.permission.read_external_storage"/> 2. 其他权限配置, 根据当前渠道要求自行增加, 详情查看当前渠道 SDK 的 DEMO 3. 游戏工程的 AndroidManifest.xml 中必须配置 android:minsdkversion 和 android:targetsdkversion, 例如 <uses-sdk android:minsdkversion="7" android:targetsdkversion="17" /> value 值请根据游戏的实际适配情况自行设置 4.3. 备注说明 1. 导入过程中可能因为重复引用 LIB 库导致编译报错, 在项目工程中移除重复的 LIB 库即可 2. 某些渠道关于横竖屏展示问题, 需游戏自行在 AndroidManifest.xml 中设置 3. AndroidManifest.xml 中所需配置的渠道参数, 需由产品管理人员申请后填写正确的参数, 不要使用 DEMO 中的 value 4.4 Debug SO 文件提取 12 应用接入文档 北京掌趣科技股份有限公司

13 Android 平台中目标文件对应的是 SO 文件,Debug SO 文件是指具有调试信息的 SO 文件 为了能快速并准确地定位用户 APP 发生 Crash 的代码位置, 掌趣崩溃日志收集功能使用 Debug so 对 APP 发生 Crash 的程序堆栈进行解析和还原 注意 : 该说明主要针对使用了 NDK 的安卓项目 1. 如何定位 Debug SO 文件 IDE: Eclipse IDE 如果使用 Eclipse+NDK, 默认情况下,Debug SO 文件将位于 : < 项目文件夹 (Project Directory)>/obj/local/< 架构 (Architecture)>/ 如下图所示 : IDE: Android Sutdio IDE 如果使用 Android Sutdio+NDK, 默认情况下,Debug 编译的 Debug SO 文件将位于 : < 子项目文件夹 >/build/intermediates/ndk/debug/obj/local< 架构 (Architecture)>/ 而 Release 编译的 Debug SO 文件将位于 : < 子项目文件夹 >/build/intermediates/ndk/release/obj/local< 架构 (Architecture)>/ 注意 :Android Sutdio 中 " 子项目 " 即 Module 如下图所示 : 13 应用接入文档 北京掌趣科技股份有限公司

14 14 应用接入文档 北京掌趣科技股份有限公司

15 2.Debug SO 文件上传将取得的 Debug so 文件按照 CPU 架构压缩成 zip 将压缩好的文件, 由产品经理上传至 MIS 平台游戏包管理处, 每个版本对应一个符号文件 5. 登录 / 注册流程 5.1. 流程说明 具体流程如下 : 15 应用接入文档 北京掌趣科技股份有限公司

16 1. 手机游戏客户端会调用掌趣 sdk 进行 sdk 初始化操作 1. 掌趣 sdk 向掌趣用户中心服务器发起登录 / 注册的请求 2. 掌趣用户中心服务器向掌趣 sdk 返回 token 用户信息等等 3. 掌趣 sdk 将 token 用户信息返回给游戏客户端, 游戏客户端向游戏服务器发送 token 用户信息等等 4. 游戏服务器根据 token 向掌趣用户中心服务器获取用户信息 ( 登录验证 ) 5. 掌趣用户中心服务器向游戏服务器返回用户信息 6. 游戏服务器向游戏客户端返回登录验证结果, 游戏客户端执行游戏登录 注 : 现在大部分游戏未实现 5 和 6 的流程 5.2. 接口介绍 SDK 初始化 ( 客户端调用, 必须 ) 功能说明 1. 为 SDK 中各个功能的使用提供必要的准备工作 2. 获取初始化数据 3. 检查版本更新 4. 发送激活日志 5. 初始化第三方 SDK 接口定义 * 初始化 SDK * gametype 16 应用接入文档 北京掌趣科技股份有限公司

17 * 游戏类型 1: 网游 ;2: 单机 * gamever * 游戏版本号 gameresver * 游戏资源版本号, 无资源版本号可传 "" listener * 回调接口 publicvoid Ourpalm_Init(String gametype, String gamever, String gameresver, Ourpalm_CallBackListener listener) 参数说明 参数名称重要性类型说明 gametype 必须 String 游戏类型 publicstaticfinal String GameType_Online = "1"; // 网 游 publicstaticfinal String GameType_Console = "2"; // 单 gamever 可选 String SDK 优先读取 AndroidManifest.xml 机 里面的版本号, 如未获取到则使用 此参数 gameresver 可选 String 游戏资源版本号, 如游戏无此概念 Listener 必须 Ourpalm_CallBackLi stener 则可以传 游戏需实现此回调中的所有接口 接口示例 // 初始化 SDK Ourpalm_Entry.getInstance(this).Ourpalm_Init(GameInfo.GameTyp e_online, gamever, gameresver, new Ourpalm_CallBackListener() { publicvoid Ourpalm_LogoutSuccess() { // 游戏必须实现 publicvoid Ourpalm_LogoutFail(int code) { 17 应用接入文档 北京掌趣科技股份有限公司

18 // 由游戏决定是否实现 publicvoid Ourpalm_LoginSuccess(String tokenid, String data) { // 游戏必须实现 Logs.i("info", "MainActivity, tokenid == " + tokenid + ", user data == " + data); Ourpalm_Token = tokenid; try { JSONObject json = new JSONObject(data); Ourpalm_UID = json.getstring("id"); Ourpalm_UNAME = json.getstring("username"); catch (JSONException e) { // TODO Auto-generated catch block e.printstacktrace(); Toast.makeText(MainActivity.this, " 登录成功 ", Toast.LENGTH_LONG).show(); publicvoid Ourpalm_LoginFail(int code) { // 游戏必须实现 Toast.makeText(MainActivity.this, " 登录失败, code == " + code, Toast.LENGTH_LONG).show(); publicvoid Ourpalm_InitSuccess() { publicvoid Ourpalm_InitFail(int code) { 18 应用接入文档 北京掌趣科技股份有限公司

19 publicvoid Ourpalm_ExitGame() { // 游戏使用掌趣 SDK 退出接口时必须实现此回调 MainActivity.this.finish(); publicvoid Ourpalm_SwitchingAccount(boolean Success, String tokenid, String userinfo) { // 当前渠道 SDK 带有切换账号功能时, 游戏需要实现此接口逻辑 // Success=true 表示切换成功,Success=false 表示切换失败, tokenid 和 userinfo 同登录成功接口 ); 回调接口说明 (Ourpalm_CallBackListener) 登录注销成功 :publicvoid Ourpalm_LogoutSuccess(); 登录注销失败 :publicvoidourpalm_logoutfail(int code); 登录成功 :publicvoid Ourpalm_LoginSuccess(String tokenid, String data); 登录失败 :publicvoid Ourpalm_LoginFail(int code); 初始化成功 :publicvoid Ourpalm_InitSuccess(); 初始化失败 :publicvoid Ourpalm_InitFail(int code); 退出游戏 :publicvoid Ourpalm_ExitGame(); 切换账号回调 :publicvoid Ourpalm_SwitchingAccount(boolean Success, String tokenid, String userinfo) 以上接口中的 code 参数为错误码 publicvoid Ourpalm_LoginSuccess(String tokenid, String data) 参数说明 参数名称 重要性 类型 说明 tokenid 必须 String 掌趣用户中心返回的当前登录用户的 tokenid, 游戏客户需将此参数的值传给 19 应用接入文档 北京掌趣科技股份有限公司

20 游戏服务器, 游戏服务器需来掌趣用户中心进行登录验证, 验证通过才能让用户进入游戏, 详看登录验证接口 data 必须 String 当前登录用户的用户信息数据 返回数据举例 : tokenid == 45bf7d3b d-b660-b872ba4c831d, data == {"id":" ","username":"oplat ","returnJson":{"ErrorCode":"1","ErrorDesc":" 有效 " id: 掌趣用户中心生成的用户 ID, 游戏应以此 ID 作为用户登录的唯一标识, 用户 ID 区分大小写 如果游戏有自己的用户 ID, 必须和掌趣用户中心的用户 ID 一一对应, 不得出现一对多或者多对一的情况 也不得根据其他条件, 组合生成新的用户 ID, 否则将会出现账号丢失的情况 username: 掌趣用户中心生成的用户名称 ( 使用第三方登录或者官网游客登录则返回空 ) 登陆失败回调说明 public void Ourpalm_LoginFail(int code) 参数说明 参数名称重要性类型说明 code 必须 Int 登陆失败错误码! 错误码为 : Ourpalm_ErrorCode.Login_Error_StateFail ure 代表会话失效, 需要特殊处理为重新登陆 适用于 : 1. 该用户在其他设备, 同一款游戏登陆 2. 该用户同 SDK 服务器会话链接长久失联 3. 该用户被 SDK 服务器踢下线 4. 该用户在网页或者其他设备上修改密码 其他错误码为登陆失败 登录 ( 客户端调用, 必须 ) 功能说明 20 应用接入文档 北京掌趣科技股份有限公司

21 1. 调用第三方 SDK 的登录功能 2. 当为官网包时会自动调用掌趣官网登录界面 接口定义 * 登录接口 publicvoid Ourpalm_Login() 接口示例 Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_Login(); 登录 ( 客户端调用, 可选, 为兼容官网老版本接口形式 ) 功能说明 1. 调用掌趣官网登录界面, 并可将游戏传入的用户名和密码显示到登录界面的对应输入框 2. 一般情况下只需调用一次, 目的是将之前保存到游戏中的用户名和密码导入到 SDK 存储中, 使用此方法登录成功后, 下次登录应正常调用 Ourpalm_Login 方法 接口定义 * 登录接口, 可传用户名, 密码 * name * 用户名 * 密码 publicvoid Ourpalm_Login_SupportPreApi(String name, String pwd) 接口示例 Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_Login_Supp ortpreapi( 用户名, 密码 ); 登录注销 ( 客户端调用, 可选, 根据要求调用 ) 功能说明注销当前登录账号, 注销成功后会调用游戏实现功能后的注销回调接口 如当前渠道的接入规范要求调用请务必调用, 无要求可不调用 接口定义 21 应用接入文档 北京掌趣科技股份有限公司

22 * 登录注销 publicvoid Ourpalm_Logout() 接口示例 Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_Logout(); 切换账号 ( 客户端调用, 可选, 根据要求调用 ) 功能说明某些渠道 SDK 当登录过一次后下次登录会变成自动登录, 这个时候如果 SDK 内部没有注销或者切换账号的按钮, 需要游戏调用此接口实现账号切换功能 如当前渠道的接入规范要求调用请务必调用, 无要求可不调用 接口定义 * 账号切换 publicvoid Ourpalm_SwitchAccount() 接口示例 Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_SwitchAccount (); 登录成功并进入游戏后, 设置角色的注册和登录信息 ( 客户端调用, 必须 ) 功能说明成功登陆并进入游戏后, 游戏客户端必须调用此接口设置用户的角色信息, 角色信息在其他功能接口中需要用到, 如未调用则无法使用支付功能 用户首次创建或注册角色并登录时, 需要调用一次注册设置 (type=1) 和一次登陆设置 (type=2); 用户使用老角色登陆, 则只需要调用一次登陆设置 (type=2) 注意 : 游戏内没有角色注册行为的, 在游戏自动给用户创建角色的时候, 即认为注册 接口定义 * * 设置游戏角色信息 type * 1: 角色注册,2: 角色登录 22 应用接入文档 北京掌趣科技股份有限公司

23 gameservername * 当前角色所属服务器名称 gameserverid * 当前角色所属服务器 ID rolename * 当前角色名字 roleid * 当前角色 ID rolelv * 当前角色等级, 无等级可传 "" roleviplv * 当前角色 VIP 等级, 无 VIP 等级可传 "" * publicvoid Ourpalm_SetGameInfo(int type, String gameservername,string gameserverid, String rolename, String roleid, String rolelv,string roleviplv) 参数说明 参数名称 重要性 类型 说明 type 必须 int 1 表示角色注册,2 表示角色登录 gameserver name 必须 String 当前用户所在游戏服务器名称 gameserverid 必须 String 当前用户所在游戏服务器 ID rolename 必须 String 角色名称 ( 不支持富文本 ) roleid 必须 String 角色 ID rolelv 必须 String 角色等级, 如无可传 roleviplv 必须 String 角色 VIP 等级, 如无可传 接口示例 Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_SetGameInfo( 1," 服务器名称 "," 服务器 ID", " 测试角色名称 ", " 测试角色 ID", " 测试角色等级 ", " 测试角色 VIP 等级 "); 登录验证 ( 服务器调用, 可选 ) 功能说明游戏服务器端根据 token 去用户中心拿取用户信息, 该接口可以避免客户端随意修改信息的漏洞 接口采用 HTTP 请求, 参数以 JSON 数据格式,POST 方式发给用户中心 23 应用接入文档 北京掌趣科技股份有限公司

24 接口定义 请求 URL: ( 中国大陆 ) ( 香港及东南亚地区 ) ( 韩国 ) ( 日本 ) 参数说明 参数名称 重要性 类型 说明 interfaceid 必须 String 接口号, 固定填写 0002 即可 tokenid 必须 String 用户中心返回的 tokenid 接口示例 ( 接口采用 POST 格式传输 ) http body 中传输为 : jsonstr={"interfaceid":"0002","tokenid":"254af9e bd1-83ee-00f50defdc79" 返回参数说明 参数名称 重要性 类型 说明 bindingmode 必须 String 0 为手机方式绑定 ;1 为邮箱方 式绑定 logintype 必须 String 用户登录标识 : ( 0: 是第三方平台注册 1: 为官网注册 2: 为快速注册 9: 为其它平台登录 10: 为官网登录 11: 为快速登录 ) status 必须 String 返回状态 rtype reset 必须 String 状态内码 desc 必须 String 状态描述 tokenid 必须 String 单点登录标识 userinfo 必须 String 用户信息 ( 具体返回参数见示 例 ) originaluse 必须 String 用户类型 0: 第三方用户 1: 普通官网用户 24 应用接入文档 北京掌趣科技股份有限公司

25 2: 快登用户 currentuser Type userplatfor mid 必须 String 用户类型 0: 第三方用户 1: 普通官网用户 2: 快登用户 必须 String 用户系统 ID 0001: 官网用户 0231:Facebook 用户 返回 json 格式信息 : { bindingmode : 0, logintype : 10, status : 0, reset : 1000, desc : 成功, tokenid : 254af9e bd1-83ee-00f50defdc79, "currentusertype":"1", "originalusertype":"1", userinfo :{ id : 用户 id, username : 用户昵称, Tyy@163.com, returnjson :{ 该信息为第三方返回的信息 "userplatformid":"0001" 各地域接口地址清单 A 中国大陆 B 港台以及东南亚地域 C 韩国 D 日本 25 应用接入文档 北京掌趣科技股份有限公司

26 6. 充值 / 发货流程 6.1. 流程说明 具体流程如下 : 1. 掌趣 sdk 向掌趣计费服务器发起支付请求 2. 掌趣计费服务器生成订单号, 并向 sdk 返回支付结果 3. 掌趣计费服务器通知游戏服务器发货 4. 游戏服务器发送虚拟物品至玩家手机游戏客户端 5. 游戏服务器向计费服务器返回发货结果 6.2. 接口介绍 支付接口 ( 客户端调用, 必须 ) 功能说明调用自有支付功能或者第三方 SDK 的支付功能, 实现游戏中的道具购买 注意 : 对该接口中的商品名称和商品数量 2 个参数具体说明, 如游戏中所卖商品在游戏 界面显示为 100 元宝, 当调用支付接口时, 商品名称请传 元宝, 商品数量请传 100, 切记不可商品名称传 100 元宝, 商品数量传 1 26 应用接入文档 北京掌趣科技股份有限公司

27 元 ) 接口定义 * propid * 游戏自定义的商品 ID chargecash * 价格 ( 以分为单位 ) currencytype * 货币类型 (1 人民币 2 美元 3 日元 4 港币 5 英镑 6 新加坡币 7 越南盾 8 台币 9 韩 propname * 商品名称 propcount * 商品数量 propdes * 商品描述 Gameurl * 掌趣计费中心回调游戏发货地址 ExtendParams * 扩展参数 callback * 支付回调接口 rolelv * 角色等级 roleviplv * 角色 VIP 等级 publicvoid Ourpalm_Pay(final String propid, final String chargecash, final String currencytype, final String propname, final StringpropCount,finalStringpropDes, finalstring Gameurl, final String ExtendParams, final Ourpalm_PaymentCallBack callback, final String rolelv, final String roleviplv) 参数说明 参数名称重要性类型说明 propid 必须 String 游戏自定义的商品 ID, 必传 chargecash 必须 String 商品价格, 单位详见 2.3 帮助信 息中的货币类型及对应 ID currencytype 必须 String 货币类型, 详见 2.3 帮助信息中 的货币类型及对应 ID 27 应用接入文档 北京掌趣科技股份有限公司

28 propname 必须 String 商品名称 ( 不可带数量 ) propcount 必须 String 商品数量 propdes 必须 String 商品描述 Gameurl 必须 String 用户支付成功后掌趣计费中心会 回调此地址告知游戏进行道具发 放 ExtendParams 可选 String 游戏自定义数据, 支付成功后, 计费中心会将此字段数据回传给 游戏服务器 callback 必须 Ourpalm_Pay mentcallbac k 客户端回调接口 rolelv 必须 String 角色等级, 请传数字, 如游戏中无角色等级可以传 null roleviplv 必须 String 角色 VIP 等级, 请传数字, 如游戏中无角色 VIP 等级可以传 null 接口示例 Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_Pay(" 商品 ID", "100", "1", " 商品名称 ","1", " 商品描述 ", " 回调地址 "," 我是扩展参数 ", new Ourpalm_PaymentCallBack() { publicvoid Ourpalm_PaymentSuccess(int code, String ssid, String pbid) { Logs.i("info", "Ourpalm_PaymentSuccess ssid == " + ssid + ", pbid = " + pbid); Toast.makeText(MainActivity.this, " 花钱成功了 *_*", Toast.LENGTH_SHORT).show(); publicvoid Ourpalm_PaymentFail(int code, String ssid, String pbid) { Logs.i("info", "Ourpalm_PaymentFail code = " + code + "ssid == " + ssid + ", pbid = "+ pbid); Toast.makeText(MainActivity.this, " 支付失败了 ", Toast.LENGTH_SHORT).show(); 28 应用接入文档 北京掌趣科技股份有限公司

29 publicvoid Ourpalm_OrderSuccess(int code, String ssid, String pbid) { Toast.makeText(MainActivity.this, " 下单成功了 ", Toast.LENGTH_SHORT).show();, RoleLv, RoleVipLv); 回调接口说明 (Ourpalm_PaymentCallBack) 支付成功 :publicvoid Ourpalm_PaymentSuccess(intcode, String ssid, String pbid); 支付失败 :publicvoid Ourpalm_PaymentFail(int code, String ssid, String pbid); 下单成功 :publicvoid Ourpalm_OrderSuccess(int code, String ssid, String pbid) 注 : 下单成功 表示当前订单已经成功提交, 但用户是否进行支付或者支付结果未知, 以计费中心服务器的通知为准 参数说明 参数名称重要性类型说明 code 必须 Int 结果状态码 ssid 必须 String 掌趣计费中心生成的订单号, 如 支付失败或者用户取消支付时可 能返回为空 pbid 必须 String 游戏自定义商品 ID 发货通知接口 ( 服务器调用, 必须 ) 功能说明游戏计费成功后, 第三方计费平台回调掌趣计费中心, 验证通过后通知游戏发货接口 接口采用 http 请求方式通知游戏, 发货的地址由游戏方提供, 计费中心将参数以 JSON 数据格式, Post 方式发给游戏发货服务器 请求参数说明 参数名称 重要性 类型 参数说明 serviceid 必须 String 业务 ID 29 应用接入文档 北京掌趣科技股份有限公司

30 channelid 必须 String 推广渠道 ID devicegroupid 必须 String 机型组 ID localeid 必须 String 语言 ID propid 必须 String 商品 ID roleid 必须 String 游戏角色 ID userid 必须 String 游戏用户 ID serverid 必须 String 逻辑服 ID paychannelid 必须 String 支付方式 ID chargeprice 必须 String 订单金额 actualprice 必须 String 实际支付金额 chargeunitid 必须 String 计费点 ID currencytype 必须 String 货币类型 orderid 必须 String 订单号 strategy.rebate.p rice strategy.rebate.g oodid strategy.rebate.r ebatetype 可选 String 返利金额 ( 为整数, 如果有小数 则进 1) 可选 String 返利商品 ID 可选 String 返利类型 GOODID: 按照商品 ID 返利 PRICE: 按照充值金额进行返利 extendparams 可选 String 自定义字段 sign 必须 Md5(serviceI d+channelid +devicegrou pid+localeid +propid+role Id+userId+se rverid+orderi d+actualpric e+extendpar ams) 签名 请求参数格式 {serviceid:,channelid:,devicegroupid:,localeid:,propid :,roleid:,userid:,ser verid:,paychannelid:,chargeprice:,chargeunitid:,actualprice:,currencytype:, 30 应用接入文档 北京掌趣科技股份有限公司

31 orderid:,extendparams:,sign:,strategy:{rebate:{rebatetype:,price:,goodid: 响应参数说明 参数名称 重要性 类型 描述 delivercode 必须 String 发货结果 deliverdesc 必须 String 发货结果描述 ( 需要做 UrlEncode, 编码方式 UTF-8) delivercode 含义值 返回值 成功状态 含义 0001 通知成功 失败状态 预留扩展 预留扩展 1000 订单异常 ( 该订单已经发货 ) 1001 用户异常 1002 角色异常 1003 逻辑服异常 1004 商品异常 1005 发货失败 1100 预留扩展 ( 该扩展由游戏方定义, 定义后请反馈计费中心 ) 响应参数格式 {"common":{ delivercode : 0001, deliverdesc : 通知成功 特别注意 : 1. 游戏需验证订单金额 (chargeprice) 和实际支付金额 (actualprice) 是否相等, 如果不相等, 则按照实际支付金额 (actualprice) 进行处理 2. 为了保证数据安全性, 游戏服务器需要对掌趣计费中心 IP 地址做鉴权处理 大陆地区和应用宝渠道的鉴权 IP 为 : 港澳台地区的鉴权 IP 为 : 韩国地区鉴权 IP 为 : 日本地区鉴权 IP 为 : 应用接入文档 北京掌趣科技股份有限公司

32 礼包码通知发货接口 ( 服务器调用, 可选 ) 功能说明 在 WEB 端点击礼包码兑换, 掌趣计费中心验证通过后通知游戏发货接口 接口采用 http 请求方式通知游戏, 发货的地址由游戏服务端提供, 计费中心将参数 以 JSON 数据格式, Post 方式发给游戏发货服务器 请求参数说明 参数名称 重要性 类型 参数说明 serviceid 必须 String 业务 ID channelid 必须 String 推广渠道 ID devicegroupid 必须 String 机型组 ID localeid 必须 String 语言 ID propid 必须 String 商品 ID roleid 必须 String 游戏角色 ID userid 必须 String 游戏用户 ID serverid 必须 String 逻辑服 ID giftid 必须 String 礼包 ID ( 游戏内发放物品 ID) keyid 必须 String 激活码 extendparams 可选 String 自定义字段, 多个参数之间以 " " 分隔 请求参数格式 {serviceid:"",channelid:"",devicegroupid:"",localeid:"",roleid:"",userid:"", serverid:"",giftid:"",keyid:"",extendparams:"" 响应参数说明 参数名称 重要性 类型 描述 delivercode 必须 String 发货结果 deliverdesc 必须 String 发货结果描述 ( 需要做 UrlEncode, 编码方式 UTF-8) delivercode 含义值 返回值 成功状态 含义 0001 通知成功 响应参数格式 预留扩展 {"common":{"delivercode":"0001", "deliverdesc":" 通知成功 " 特别注意 : 1. 为了保证数据安全性, 游戏服务器需要对掌趣计费中心 IP 地址做鉴权处理 32 应用接入文档 北京掌趣科技股份有限公司

33 大陆地区和应用宝渠道的鉴权 IP 为 : 港澳台地区的鉴权 IP 为 : 韩国地区鉴权 IP 为 : 日本地区鉴权 IP 为 : 礼包码通知发货接口 ( 服务器调用, 可选 ) 功能说明 在 SDK 端点击礼包码兑换, 掌趣计费中心验证通过后通知游戏发货接口 接口采用 http 请求方式通知游戏, 发货的地址由游戏服务端提供, 计费中心将参数 以 JSON 数据格式, Post 方式发给游戏发货服务器 请求参数说明 参数名称 重要性 类型 参数说明 serviceid 必须 String 业务 ID channelid 必须 String 推广渠道 ID devicegroupid 必须 String 机型组 ID localeid 必须 String 语言 ID propid 必须 String 商品 ID roleid 必须 String 游戏角色 ID userid 必须 String 游戏用户 ID serverid 必须 String 逻辑服 ID giftid 必须 String 礼包 ID ( 游戏内发放物品 ID) keyid 必须 String 激活码 extendparams 可选 String 自定义字段, 多个参数之间以 " " 分隔 请求参数格式 {serviceid:"",channelid:"",devicegroupid:"",localeid:"",roleid:"",userid:"", serverid:"",giftid:"",keyid:"",extendparams:"" 响应参数说明 参数名称 重要性 类型 描述 delivercode 必须 String 发货结果 deliverdesc 必须 String 发货结果描述 ( 需要做 UrlEncode, 编码方式 UTF-8) delivercode 含义值 返回值 含义 成功状态 0001 通知成功 33 应用接入文档 北京掌趣科技股份有限公司

34 响应参数格式 预留扩展 {"common":{"delivercode":"0001", "deliverdesc":" 通知成功 " 特别注意 : 1. 为了保证数据安全性, 游戏服务器需要对掌趣计费中心 IP 地址做鉴权处理 大陆地区和应用宝渠道的鉴权 IP 为 : 港澳台地区的鉴权 IP 为 : 韩国地区鉴权 IP 为 : 日本地区鉴权 IP 为 : 日志接入流程 具体内容请参考 掌趣日志接入文档 - 安卓版 文档 8. 其它功能接口 8.1. Activity 生命周期方法的调用 ( 客户端调用, 必须 ) 功能说明 因为某些第三方 SDK 需要用到生命周期中的某些方法, 所以游戏客户端 Activity 中必须调用掌趣 SDK 中定义的生命周期方法, 否则可能会出现不可预估的问题 接口定义 1 * 调用 SDK 生命周期 publicvoid Ourpalm_onRestart() 接口示例 1 protectedvoid onrestart() { 34 应用接入文档 北京掌趣科技股份有限公司

35 super.onrestart(); Logs.i("info", "onrestart"); Ourpalm_Entry.getInstance(this).Ourpalm_onRestart(); 接口定义 2 * 调用 SDK 生命周期 publicvoid Ourpalm_onResume() 接口示例 2 protectedvoid onresume() { super.onresume(); Logs.i("info", "onresume"); Ourpalm_Entry.getInstance(this).Ourpalm_onResume(); 接口定义 3 * 调用 SDK 生命周期 publicvoid Ourpalm_onStart() 接口示例 3 protectedvoid onstart() { super.onstart(); Logs.i("info", "onstart"); Ourpalm_Entry.getInstance(this).Ourpalm_onStart(); 接口定义 4 * 调用 SDK 生命周期 publicvoid Ourpalm_onStop() 接口示例 4 35 应用接入文档 北京掌趣科技股份有限公司

36 protectedvoid onstop() { super.onstop(); Logs.i("info", "onstop"); Ourpalm_Entry.getInstance(this).Ourpalm_onStop(); 接口定义 5 * 调用 SDK 生命周期 publicvoid Ourpalm_onPause() 接口示例 5 protectedvoid onpause() { super.onpause(); Logs.i("info", "onpause"); Ourpalm_Entry.getInstance(this).Ourpalm_onPause(); 接口定义 6 * 调用 SDK 生命周期 publicvoid Ourpalm_onActivityResult(int requestcode, int resultcode,intent data) 接口示例 6 protectedvoid onactivityresult(int requestcode, int resultcode, Intent data) { super.onactivityresult(requestcode, resultcode, data); Logs.i("info", "onactivityresult"); Ourpalm_Entry.getInstance(this).Ourpalm_onActivityResult(request ode, resultcode, data); 36 应用接入文档 北京掌趣科技股份有限公司

37 接口定义 7 * 销毁 SDK publicvoid Ourpalm_onDestroy() 接口示例 7 protectedvoid ondestroy() { super.ondestroy(); Logs.i("info", "ondestroy"); Ourpalm_Entry.getInstance(this).Ourpalm_onDestroy(); 接口定义 8 * newconfig publicvoid Ourpalm_onConfigurationChanged(Configuration newconfig) 接口示例 8 publicvoid onconfigurationchanged(configuration newconfig) { super.onconfigurationchanged(newconfig); Logs.i("info", "onconfigurationchanged"); Ourpalm_Entry.getInstance(this).Ourpalm_onConfigurationChanged(ne wconfig); 接口定义 9 * 游戏界面声明 onnewintent intent publicvoid onnewintent(intent intent) 接口示例 9 37 应用接入文档 北京掌趣科技股份有限公司

38 protectedvoid onnewintent(intent intent) { super.onnewintent(intent); Logs.i("info", "onnewintent"); Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_onNewIntent(intent); 8.2. 获取可选接口中的可用接口 ( 客户端调用, 必须 ) 功能说明用户中心, 切换账号, 登录注销 等接口必须接入 提供此接口用来引导游戏合理使用以上三个接口 根据 SDK 返回的值, 判断是否在相应渠道客户端中显示或隐藏 UI 展示, 以及和是否调用以上三个接口 比如当前渠道需要调用用户中心接口, 则需要将用户中心按钮显示出来并实现其接口调用的功能, 如不需要, 则需要隐藏用户中心的按钮 其他功能同理 此三个功能 SDK 只提供功能接口, 无 UI 显示, 所以需要游戏实现展示或者隐藏 用户中心, 切换账号, 登录注销 的 UI 按钮 根据返回值给予显示或者隐藏 接口定义 * 获取当前渠道游戏包是否要调用 用户中心, 切换账号, 登录注销 等接口 public String Ourpalm_GetEnableInterface() 接口示例 String enable = Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_GetEnableInt erface(); Logs.i("info", "enable == " + enable); 返回数据如下,JSON 格式 {"Logout":"Disabled","SwitchAccount":"Disabled","UserCenter":"Enabled" Enabled: 表示需要调用 Disabled: 表示不需要调用 38 应用接入文档 北京掌趣科技股份有限公司

39 例如以上返回数据说明 : 登录注销接口不需要调用 ; 切换账号接口不需要调用, 进入 用户中心接口需要调用 8.3. 进入用户中心 ( 或论坛 ) 接口 ( 客户端调用, 可选, 根据要求调用 ) 功能说明进入第三方渠道 SDK 的用户中心或者论坛界面, 或者进入官网 SDK 的用户中心界面 如当前渠道的接入规范要求调用请务必调用, 无要求可不调用 接口定义 * 进入用户中心接口, 如果是用官网登录的则进入官网的用户中心 publicvoid Ourpalm_GoCenter() 接口示例 Ourpalm_Entry.getInstance(MainActivity.this).Ourpalm_GoCenter(); 8.4. 退出游戏接口 ( 客户端调用, 必须 ) 功能说明调用第三方 SDK 的退出提示接口, 如第三方 SDK 无退出提示接口则调用掌趣的退出提示界面或者直接退出游戏 接口定义 * * 调用第三方 SDK 退出提示页面, 如果第三方 SDK 无退出提示页面则调用掌趣提示页面 usetip * 是否使用掌趣 SDK 的退出提示界面 publicvoid Ourpalm_ExitGame(boolean usetip) 参数说明 参数名称重要性类型说明 Usetip 必须 Boolean 决定是否使用掌趣 SDK 自带的退 出提示界面, 如果第三方 SDK 带 有退出提示界面, 此参数无效 39 应用接入文档 北京掌趣科技股份有限公司

40 接口示例 publicboolean onkeydown(int keycode, KeyEvent event) { if (keycode == KeyEvent.KEYCODE_BACK) { Ourpalm_Entry.getInstance(this).Ourpalm_ExitGame(true); returntrue; returnsuper.onkeydown(keycode, event); 8.5. 开启 SDK 日志输出 ( 客户端调用, 可选 ) 功能说明打开后能在 logcat 看到 SDK 的日志输出,TAG 为 info 和 msg, 用于游戏接入 SDK 的调试阶段, 出正式游戏包时请务必关闭日志输出 接口定义 * 是否打开日志 * log publicvoid SetLogs(boolean log) 参数说明 参数名称重要性类型说明 log 必须 Boolean 是否打开日志输出 接口示例 // 设置打开日志输出 Ourpalm_Entry.getInstance(this).SetLogs(true); 8.6. 获取业务 ID( 客户端调用, 可选 ) 功能说明获取当前游戏包内打入的业务 ID 接口定义 40 应用接入文档 北京掌趣科技股份有限公司

41 * 业务 ID public String getserviceid() 接口示例 Ourpalm_Entry.getInstance(this).getServiceId(); 8.7. 获取渠道 ID( 客户端调用, 可选 ) 功能说明获取当前游戏包内打入的渠道 ID 接口定义 * 渠道 ID public String getchannelid() 接口示例 Ourpalm_Entry.getInstance(this).getChannelId(); 8.8. 获取机型组 ID( 客户端调用, 可选 ) 功能说明获取当前游戏包内打入的机型组 ID 接口定义 * 机型组 ID public String getdevicegroupid() 接口示例 Ourpalm_Entry.getInstance(this).getDeviceGroupId(); 8.9. 获取语言 ID( 客户端调用, 可选 ) 41 应用接入文档 北京掌趣科技股份有限公司

42 功能说明获取当前游戏包内打入的语言 ID 接口定义 * 语言 ID public String getlocaleid() 接口示例 Ourpalm_Entry.getInstance(this).getLocaleId(); 获取 OPID 功能说明获取当前游戏包内打入的 OPID 接口定义 * OPID public String getopid() 接口示例 Ourpalm_Entry.getInstance(this).getOpId(); 查询排行榜是否有活动接口 ( 客户端调用可选 ) 功能说明判断游戏在当前时间是否有正在进行中的活动, 方便游戏活动接口的显示做出判断, 如果存在活动, 返回给游戏活动相关参数 接口定义 * 查询排行榜是否有活动 * ranklist_callback Ourpalm_WithCampaign 有活动 42 应用接入文档 北京掌趣科技股份有限公司

43 Ourpalm_WithOutCampaign 暂无活动 publicvoid Ourpalm_RankListAnyCompaign(final Ourpalm_RankList_CallBack ranklist_callback) 参数说明 参数名称 重要性 类型 说明 ranklist_callbac k 必须 Ourpalm_RankLis t_callback 游戏必须实现此回调的所以接口 接口示例 Ourpalm_Entry.getInstance(this).Ourpalm_RankListAnyCompaign(new Ourpalm_RankList_CallBack() { publicvoid Ourpalm_WithCampaign(JSONObject arg0) { Ourpalm_Toast.makeText(MainActivity.this, " 有活动, 活动 : "+arg0.tostring(), Toast.LENGTH_SHORT); publicvoid Ourpalm_Withoutcampaign(int code) { Ourpalm_Toast.makeText(MainActivity.this, " 查询失败或无活动,code == " + code, Toast.LENGTH_SHORT); ); 返回游戏的值为 Json 数据举例为 {"actid":25,"actname":"sdk 排行榜测试 ". 方便游戏进行下一步操作 打开排行榜积分榜页面接口 ( 客户端调用可选 ) 功能说明游戏在判断有活动的前提下, 调用此接口, 打开排行榜页面 接口定义 Ourpalm_Entry.getInstance(this).Ourpalm_OpenRankList(); 43 应用接入文档 北京掌趣科技股份有限公司

44 接口示例 Ourpalm_Entry.getInstance(this).Ourpalm_OpenRankList(); 排行榜积分操作接口 ( 客户端调用可选 ) 功能说明游戏进行对积分的操作, 包括增加积分和减少积分, 前提用户必须登录接口定义 * 排行榜积分操作接口 * score type * 0 为加积分 1 为减积分 score_callback publicvoidourpalm_randlistscore(finalint score, finalint type, final Ourpalm_RankList_ScoreCallBack score_callback) 参数说明参数名称 重要性 类型 说明 score 必须 int 游戏需要操作的积分 type 必须 int 操作类型 0 为增加 1 为减少 score_callback 必须 Ourpalm_RankLis t_scorecallback 游戏必须实现此回调所有接口 接口示例 Ourpalm_Entry.getInstance(this).Ourpalm_RandListScore(100, 0, new Ourpalm_RankList_ScoreCallBack() { publicvoid Ourpalm_ScoreSuccess() { Ourpalm_Toast.makeText(MainActivity.this, " 积分操作成功 ", Toast.LENGTH_SHORT); publicvoid Ourpalm_ScoreFail(int code) { 44 应用接入文档 北京掌趣科技股份有限公司

45 Ourpalm_Toast.makeText(MainActivity.this, " 积分操作失败,code == " + code, Toast.LENGTH_SHORT); ); 打开排行榜活动公告页面 ( 客户端调用可选 ) 接口说明存在活动的前提下, 调用接口, 打开活动公告, 点击查看详情, 返回游戏活动相关信息 接口定义 * 打开排行榜活动公告弹窗 * activitycallback publicvoid Ourpalm_OpenRankListActivity( final Ourpalm_RankList_ActivityCallBack activitycallback) 参数说明 参数名称 重要性 类型 说明 activitycallback 必须 Ourpalm_RankLis t_activitycallb ack 游戏必须实现此回调所有接口 接口示例 : Ourpalm_Entry.getInstance(this).Ourpalm_OpenRankListActivity(new Ourpalm_RankList_ActivityCallBack() { publicvoid Ourpalm_ActivitySuccess(JSONObject str) { Ourpalm_Toast.makeText(MainActivity.this, " 开始查看活动 ", Toast.LENGTH_SHORT); publicvoid Ourpalm_ActivityFail(int code) { Ourpalm_Toast.makeText(MainActivity.this, " 打开活动页面 45 应用接入文档 北京掌趣科技股份有限公司

46 失败, code == " + code, Toast.LENGTH_SHORT); ); 返回游戏的值为 Json 数据举例为 {"actid":25,"actname":"sdk 排行榜测试 ". 方便游戏进行下一步操作 查询当前是否有新活动公告 接口说明 : 对比当前活动时间和前一次活动的时间, 返回给游戏是否有新公告 接口定义 : * 查询是否有新活动公告 * activitynoticelistener publicvoid Ourpalm_ActivityNoticeisNotice( final Ourpalm_ActivityNotice.ActivityNoticeListener activitynoticelistener) 接口示例 : Ourpalm_Entry.getInstance(this).Ourpalm_ActivityNoticeisNotice(new ActivityNoticeListener() { publicvoid Ourpalm_NonNewNotice() { Toast.makeText(MainActivity.this, " 当前没有新活动 ", Toast.LENGTH_SHORT).show(); publicvoid Ourpalm_ExistNewNotice() { ); Toast.makeText(MainActivity.this, " 当前有新活动 ", Toast.LENGTH_SHORT).show(); 打开活动公告页面 46 应用接入文档 北京掌趣科技股份有限公司

47 接口说明 : 打开活动公告页面进行展示 接口定义 : * 打开活动公告页面 * * publicvoid Ourpalm_OpenActivityNoticeWebView() 接口示例 : Ourpalm_Entry.getInstance(this).Ourpalm_OpenActivityNoticeWebView(); 礼包码兑换接口 接口说明 : 兑换礼包码 CP 接入礼包码功能时, 由 SDK 来直接提示错误提示语 AndroidManifest.xml 的配置 <activity android:name="ourpalm.android.opservice.ourpalm_opservice_activity" android:configchanges="keyboardhidden orientation screensize" android:theme="@android:style/theme.translucent.notitleba" > </activity> 接口定义 * 礼包码兑换接口 * GiftCode 礼包码 url 发货地址 extendparams 扩展参数 mlistener 回调 publicvoid Ourpalm_GiftExchange(String GiftCode, String url, final String extendparams, final Ourpalm_GiftExchangeCallBack mlistener) 参数说明 参数名称 重要性 类型 说明 47 应用接入文档 北京掌趣科技股份有限公司

48 GiftCode 必选 String 礼包码 url 必选 String 发货地址 extendparams 可选 String 透传参数, 成功回调内, 将会返回此参数 mlistener 必选 GiftExchangeCal lback 结果回调, 成功回调内参数说明 packageid 接口示例 : Ourpalm_Entry.getInstance(this).Ourpalm_GiftExchange( medittext.gettext().tostring(), "", "", new Ourpalm_GiftExchangeCallBack()); 回调接口说明 (GiftExchangeCallBack ) 兑换成功 : * 操作成功 * packageid 礼包码 ID * extendparams 自定义参数 ( 游戏传进来的自定义参数 ) publicabstractvoid Ourpalm_Success(String packageid, String extendparams); 兑换失败 : * 操作失败 * code * 错误码 publicabstractvoid Ourpalm_Fail(int code); 分享接口 ( 客户端调用可选 ) 接口说明 : 实现第三渠道的分享接口接口定义 * 分享接口 ( 可选功能 ) thirdtype * 第三方类型 ID sharedata * 分享的数据对象 public void Ourpalm_GoSnsShare(final intthirdtype,final BundleshareData) 参数说明 48 应用接入文档 北京掌趣科技股份有限公司

49 参数名称重要性类型说明 thirdtype 必须 int 第三方类型 ID( 具体参见后面说明 ) sharedata 可选 String 分享的数据对象 ( 具体参见后面说明 ) 接口示例 : // 分享接口, 以微信分享为例 Bundle sharedata = new Bundle(); sharedata.putstring(snsshareinfo.params.message_title, "test 微信 "); sharedata.putstring(snsshareinfo.params.message_content, "test 分享图片 "); String path="/storage/sdcard0/1.jpg"; path); sharedata.putstring(snsshareinfo.params.local_img_path, Ourpalm_Entry.getInstance(this).Ourpalm_GoSnsShare(SnsShareInfo.Third PartyTag.WEIXIN, sharedata); 特别说明 : thirdtype( 第三方类型 ID) 支持如下四个类型 : 微信 :SnsShareInfo.ThirdPartyTag.WEIXIN 新浪微博 :SnsShareInfo.ThirdPartyTag.SINA Facebook:SnsShareInfo.ThirdPartyTag.FACEBOOK SMS:SnsShareInfo.ThirdPartyTag.SMS sharedata( 分享的数据对象 ) 支持如下四种 : 分享的文字标题 :SnsShareInfo.Params.MESSAGE_TITLE 分享的文字内容 :SnsShareInfo.Params.MESSAGE_CONTENT 分享的本地图片路径 :SnsShareInfo.Params.LOCAL_IMG_PATH 分享中的网络链接 :SnsShareInfo.Params.NET_URL 客服反馈接口 ( 客户端调用可选 ) 接口说明 : 游戏登录成功后, 调用此接口, 打开客服反馈页面 接口定义 : * 进入客服反馈页面 * public void EnterServiceQuestion() 49 应用接入文档 北京掌趣科技股份有限公司

50 参数说明 : 无 参数名称重要性类型说明 接口示例 : Ourpalm_OpService_Entry.getInstance().EnterServiceQuestion(); 查询客服是否有新的回复 ( 客户端调用可选 ) 功能说明登录成功后调用, 查询用户在客服反馈提交的问题是否有新的回复 接口定义 * 查看是否有新的问题回复 listener 回调接口 public void GetNewReplyInfo(final OurpalmOpServiceCallBack opservicelistener) 参数说明 参数名称 重要性 类型 说明 opservicelist 必须 OurpalmOpSer 游戏必须实现此回调的接口 ener vicecallback 接口示例 Ourpalm_OpService_Entry.getInstance().GetNewReplyInfo(new OurpalmOpServiceCallBack() { public void Ourpalm_OpServiceResult(int resultcode) { Logs.i("info", "GetNewReplyInfo Result ="+resultcode); if (resultcode == 0) { Toast.makeText(MainActivity.this, " 您在客服提的问题有回复了, 请查看 ", Toast.LENGTH_SHORT).show(); 50 应用接入文档 北京掌趣科技股份有限公司

51 Logs.i("info", "GetNewReplyInfo Success"); else if (resultcode == 1) { Logs.i("info", "GetNewReplyInfo fail"); else { Logs.i("info", "GetNewReplyInfo error"); ); 参照示例,Ourpalm_OpServiceResult 返回值说明 : 属性类型取值 resultcode int 0: 有新的问题回复 1: 没有新的问题回复 2: 网络请求异常 51 应用接入文档 北京掌趣科技股份有限公司