啪啪 sdk2.1 接入指南 V2.1

Size: px

Start display at page:

Download "啪啪 sdk2.1 接入指南 V2.1"

硬分臧
4 years ago
Views:

1 啪啪 sdk2.1 接入指南 V2.1

2 目录手机支付控件接入指南概述接入流程申请资源快速接入支付流程 Android 客户端 SDK 结构说明接口说明初始化客户端调用 ( 必接 ) 登录接口客户端调用 ( 必接 ) 切换帐号接口客户端调用 ( 选接 ) 创建角色接口客户端调用 ( 必接 ) 销毁接口客户端调用 ( 必接 ) 支付接口客户端调用 ( 必接 ) 退出游戏接口客户端调用 ( 必接 ) 支付结果通知接口 - 接入方服务器端提供实现 ( 必接 ) 用户中心接口客户端调用 ( 选接 ) 登录二次验证接口客户端调用 ( 选接 ) 进入游戏接口客户端调用 ( 必接 ) 权限与配置权限声明 ACTIVITY&SERVICE 声明 Key 声明开发者注意事项...23

3 7 附录老版本升 2.1 版本...24 library 依赖集成方式直接 COPY 集成方式概述手机支付控件 ( 以下简称支付控件 ), 主要为合作商户的手机客户端提供安全便捷的支付服务支付控件目前支持 Android 平台用户通过在支付控件中输入银行卡号手机号密码 ( 借记卡和预付卡 ) 或手机充值卡有效期 ( 信用卡 ) 验证码等要素完成支付本 sdk 为安卓应用提供登录注册支付礼包资讯等功能面向的读者是安卓应用开发者, 包括客户端和服务器工程师 2 接入流程 2.1 申请资源 key 申请接入方需要在开放平台内申请 app_key app_private_key 以及 app_secret_key 一个游戏对应一组唯一的 key 其中 app_key 和 app_private_key 配置在客户端中使用 app_secret_key 在服务端使用, 用于签名校验回调地址配置接入方需要将支付成功回调地址在支付时作为参数传入 sdk 注意 : 将商户应用包名后缀追加.papa SDK 开发包

4 SDK 开发包包含了 papa_sdk_x.x_copyproject 及 papa_sdk_x.x_libproject papa_sdk_x.x_copyproject 是以直接 COPY 资源的方式进行接入 papa_sdk_x.x_libproject 是以 library 依赖方式进行接入 2.2 快速接入 SDK 开发资料中包含了二个样例工程工程提供了一个接入的范例可以看到接入所需的所有样例代码及各功能演示生产环境可依照该样例工程进行配置使用具体代码在文件夹客户端开发包及 demo-android 中本例以 library 依赖方式接口工程为例 1. Intellij IDEA 或 studio 样列 papasdklib 是依赖库, 主工程需要依赖此工程运行 sdkdemo 是 demo 的主工程 ( 对应游戏主工程 ) jar 包确保 lib 工程文件完整, 包括 :assets 内的 so 文件,data.bin,libs 文件夹内

5 注意 : 此 lib 工程已包含的依赖包如下图所示, 其中红色方框选中的 lib 包如有需要可以移至主工程或者使用新版本 jar 包其他 jar 包都已打入 papapaylib.jar, 注意不要重复添加 jar 包 Library 工程注意在引入 jar 包时在 Export 中勾选 papapaylib 包主工程需要在 packaging 中选中 Include assets from dependencies into APK

6 2. Eclips 环境 2.1 导入 lib 工程 papasdklib 并引入主工程如下图 2.2 确保 lib 工程完整性

7 注意 : 此 lib 工程已包含的 jar 包如下图, 其中红色方框选中的 lib 包如有需要可以移至主工程或者使用新版本 jar 包其他 jar 包都已打入 papapaylib.jar, 注意不要重复添加 jar 包 2.3 将 library 工程下的 assets 目录中的内容, 移动到主工程 assets 中也可将依赖包 asserts 全部 copy 到主工程中进行引用 3 支付流程流程图说明 : 1) 商户接入 SDK 后, 首先要调用 init 方法进行初始化操作

8 2) 商户调用登录接口若用户未登录过则系统呼出登录窗口, 让用户去进行登录操作若本地已登录过, 则直接 SDK 直接进行自动登录操作 3) 商户根据用户选择的商品, 拼接支付参数, 向 SDK 发起支付请求 4) SDK 验证参数通过之后, 呼出支付渠道选择页面 5) 用户选择渠道后, 进行支付操作 6) SDK 返回支付结果给商户客户端 7) SDK 异步回调商户服务器通知支付最终结果 4 Android 客户端 4.1 SDK 结构说明 library 依赖方式接入 papa_sdk_x.x_libproject 是一个依赖方式样列工程 papasdklib 是一个 library 类型的工程, 请将该工程作为应用的依赖 ; 将 assets 文件夹下的内容放至主工程的 assets 文件夹下 ; 具体可参考 demo 样例工程 (eclips) 直接 COPY 方式接入 papa_sdk_x.x_copyproject 是一个直接 COPY 资源方式接入的样例工程将 libs 文件夹下的内容放至主工程的 libs 文件夹下 ; 具体可参考 demo 样例工程将 assets 文件夹下的内容放至主工程的 assets 文件夹下 ; 具体可参考 demo 样例工程将 res 文件夹下的内容放至主工程的 res 文件夹下 ; 具体可参考 demo 样例工程以上两种接入方式的区别在于, 在使用 library 依赖方式的情况下, 图片布局等需要生成 R 的资源, 都会生成以啪啪 SDK 为包名的 R 文件如果直接 COPY

9 资源则会发生找不到 com.papa91.pay$r xxx 的错误而使用直接 COPY 方式, 则需要使用 papa_sdk_x.x_copyproject 的工程, 把该工程内的资源全部 COPY 到接入游戏程序内, 这样 SDK 中的资源, 会生成以游戏为主的 R 文件 4.2 接口说明初始化客户端调用 ( 必接 ) 对 SDK 控件进行必要的初始化, 必须在启动程序后的第一时间加载主 Activity 中的 oncreate 方法中调用 PPayCenter. init(context); 登录接口客户端调用 ( 必接 ) PPayCenter.login(this, new PPLoginCallBack() public void onloginfinish(loginresult result) { msg.settext(result.tostring()); switch (result.getcode()) { case LoginResult.LOGIN_CODE_APPID_NOT_FOUND: // 没找到 appid break; case LoginResult.LOGIN_CODE_SUCCESS:// 登录成功 String openuid=result.getopenuid();// 返回 openuid break; case LoginResult.LOGIN_CODE_FAILED:// 登录失败 String message=result.getmessage();// 失败详情 break; case LoginResult.LOGIN_CODE_CANCEL:// 登录取消

10 break; case LoginResult.NOT_INIT:// 没有调用 PPayCenter.init(activity); break; }); } } 返回值 LoginResult code 返回值说明参数名说明值 LOGIN_CODE_APPID_NOT_FOUND 没找到 appid 1000 LOGIN_CODE_SUCCESS 登录成功 1001 LOGIN_CODE_FAILED 登录失败 1002 LOGIN_CODE_CANCEL 登录取消 1003 NOT_INIT 没有调用 8888 LoginResult 名称 code message openuid token 说明返回结果码结果说明开放平台用户编号登录 token 切换帐号接口客户端调用 ( 选接 ) PPayCenter.changeAccount(PPLoginCallBack callback); 游戏方在游戏菜单或其他需要的位置添加切换帐号的入口, 方便用户切换账号应用调用该接口,SDK 显示登录页面, 用户可更换帐号进行登录之后的登录游戏和返回结果和登录接口一样

11 4.2.4 创建角色接口客户端调用 ( 必接 ) PPayCenter. createrole(rolename,district,server); 当用户在游戏内完成角色创建后, 调用参数名说明必填 rolename 角色名 Y district 区标识 ( 数字无则填 0) Y server 服标识 ( 数字 ) Y 销毁接口客户端调用 ( 必接 ) PPayCenter.destroy(); 在应用主 Activity 中, 调用以退出登录状态并释放资源调用该接口后,SDK 又回到未初始化状态支付接口客户端调用 ( 必接 ) 参数名说明必填 APP_NAME 游戏名称 Y APP_ORDER_ID 游戏方内部订单号 Y APP_DISTRICT 区标识 ( 数字 ) N APP_SERVER 服标识 ( 数字 ) N APP_USER_ID 用户角色编号 Y APP_USER_NAME 用户角色名称 Y PRODUCT_ID 购买产品编号 Y PRODUCT_NAME 购买产品名称 Y MONEY_AMOUNT 金额 ( 单元 : 元 ) Y NOTIFY_URL 通知回调接口 Y PA_OPEN_UID 登录后返回的用户编号 Y APP_EXT1 附加信息 ( 回调时原样返回 ) N

12 APP_EXT2 附加信息 ( 回调时原样返回 ) N 退出游戏接口客户端调用 ( 必接 ) PPayCenter.loginOut(this,openUid, new PpaLogoutCallback(){}); 当客户点击退出按钮时 ( 用户想退出游戏时 ) 调用,SDK 显示退出确认窗口当用户选择确定退出后, 回调结果码返回 LogoutResult.LOGOUT_CODE_OUT 这时, 游戏进行退出游戏操作, 关闭整个程序支付结果通知接口 - 接入方服务器端提供实现 ( 必接 ) 客户端调用支付接口时, 需要指定支付结果的通知回调地址 notify_url 支付完成后, 服务器会把支付结果通知到此地址服务器端收到充值完成的消息后, 给用户下发对应游戏物品服务器端应在接收到消息后, 返回 ok( 仅返回 ok 这两个字母, 不要有其他输出 ), 以回应通知若通知失败, 系统会多次尝试发送通知消息 Method: post 方式参数名说明是否参与签名 app_key 商户标识 Y app_order_id 游戏方内部订单号 Y app_district 区标识 ( 数字 ) Y app_server 服标识 ( 数字 ) Y app_user_id 用户角色编号 Y app_user_name 用户角色名称 Y product_id 购买产品编号 Y product_name 购买产品名称 Y money_amount 金额 ( 单元 : 元 ) Y pa_open_uid 登录后返回的用户编号 Y app_extra1 附加信息 ( 回调时原样返回 ) Y

app_extra2 附加信息 ( 回调时原样返回 ) Y pa_open_order_id 啪啪订单号 Y sign 签名 N 加密算法 : 将所有参与加密的参数以 key=value 形式保存到集合中, 按首字母自然排序, 然后将所有参数值拼接成字符串最后再将 app_key + app_secret_key 放置在字符串的最前面, 以 & 字符顺序拼接再将这个字符串进行 md5 生成摘要

13 app_extra2 附加信息 ( 回调时原样返回 ) Y pa_open_order_id 啪啪订单号 Y sign 签名 N 加密算法 : 将所有参与加密的参数以 key=value 形式保存到集合中, 按首字母自然排序, 然后将所有参数值拼接成字符串最后再将 app_key + app_secret_key 放置在字符串的最前面, 以 & 字符顺序拼接再将这个字符串进行 md5 生成摘要该值就是最后 sign 参数的最终值简单来说就是对上面所有参数按照 key 自然排序, 然后生成 a=v&b=v1, 然后 md5(app_key + APP_SECRET_KEY + "a=v&b=v1"). 如 app_key=123, app_secret_key=789, product_id=456, 则最后拼接后的原始待 md5 的字符串为 app_key=123&product_id=456 可参数服务端文件内的样例代码 sss

14 亦可见 : 用户中心接口客户端调用 ( 选接 ) PPayCenter.userCenter(context); 该功能作用是跳转到用户个人中心使用场景为游戏自定义菜单内, 有一个用户中心的菜单项

15 4.2.8 登录二次验证接口服务端调用 ( 选接 ) 商户在调用 SDK 登录接口, 登录成功后,SDK 登录接口返回 openuid token 商户拿到该登录信息后, 调用二次验证接口进行 token 有效性验证验证成功后, 商户进行正常后续操作请求地址 : Method: post 方式请求参数参数名说明是否参与签名 app_key 商户标识 Y uid 开放平台用户编号 Y token 登录 token Y sign 签名 ( 生成规则同通知接口 ) N 注 : 该 sign 生成规则和支付结果通知接口一致如 app_key=123 secret_key=456 token=789 uid=1001, 则 sign=md5(app_key+secret_key+sort(params)) = md5(123456app_key=123&token=789&uid=1001); 返回参数 { "error": 0, "data": { "error_msg": "", "is_success": true, #ture( 有效 ) false( 无效 ) "user_info": NULL } } 进入游戏接口客户端调用 ( 必接 ) PPayCenter. entergame(rolename,district,server); 当用户在进入游戏后或点击了进入游戏按钮用户即将进入游戏时, 调用参数名说明必填

16 rolename 角色名 Y district 区标识 ( 数字无则填 0) Y server 服标识 ( 数字 ) Y 5 权限与配置 5.1 权限声明 <uses-permission android:name="android.permission.internet"/> <uses-permission android:name="android.permission.read_phone_state"/> <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_wifi_state"/> <uses-permission android:name="android.permission.write_external_storage"/> <uses-permission android:name="android.permission.vibrate"/> <uses-permission android:name="android.webkit.permission.plugin"/> <uses-permission android:name="android.permission.system_alert_window"/> <uses-permission android:name="android.permission.get_tasks"/> 5.2 ACTIVITY&SERVICE 声明 android:name="com.papa91.pay.pa.activity.mgmainactivity" android:screenorientation="portrait" android:theme="@style/notitlenoanimation" nsize"> </activity>

17 android:name="com.papa91.pay.pa.activity.panoticedialogactivity" android:screenorientation="sensorlandscape" nsize"> </activity> android:name="com.papa91.pay.pa.activity.forumprofilefavoritesactivity" android:screenorientation="portrait" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.forumprofilemessageactivity" android:screenorientation="portrait" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.forummypostsactivity" android:screenorientation="portrait"

18 android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.forumpostsactivity" android:screenorientation="portrait" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.forumprofilemessagereplyactivity" android:screenorientation="portrait" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.widget.album.myalbumactivity" android:screenorientation="portrait" android:launchmode="singletop"

19 nsize"/> android:name="com.papa91.pay.pa.activity.oemlistactivity" android:screenorientation="portrait" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.oemdetailactivity" android:screenorientation="portrait" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.widget.photoviewer.imagepageractivity" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.sharepostsactivity"

20 android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.sharewebactivity" android:launchmode="singletop" nsize"/> android:name="com.papa91.pay.pa.activity.paayactivity" android:screenorientation="sensorlandscape" nsize" </activity> android:name="com.heepay.plugin.activity.wechatnotityactivity" android:configchanges="orientation keyboardhidden screensize" android:screenorientation="behind" />

21 android:name="com.unionpay.uppay.payactivity" android:configchanges="orientation keyboardhidden screensize" android:excludefromrecents="true" android:screenorientation="portrait"/> android:name="com.mokredit.payment.mktpayment" android:configchanges="orientation keyboardhidden screenlayout screensize" android:excludefromrecents="true" </activity>  android:name="com.alipay.sdk.app.h5payactivity" android:configchanges="orientation keyboardhidden navigation screensize" android:exported="false" android:screenorientation="behind" android:windowsoftinputmode="adjustresize statehidden"> </activity> android:name="com.alipay.sdk.auth.authactivity" android:configchanges="orientation keyboardhidden navigation" android:exported="false" android:screenorientation="behind"> </activity> android:name="com.papa91.pay.pa.activity.paloginactivity" android:screenorientation="sensorlandscape"

22 nsize" > </activity> android:name="com.mob.tools.mobuishell" android:configchanges="keyboardhidden orientation screensize" android:windowsoftinputmode="statehidden adjustresize"> <meta-data android:name="adapter" android:value="com.join.mgps.adapter.sharesdkadapter"/> <intent-filter> <data android:scheme="db-7janx53ilz11gbs"/> <action android:name="android.intent.action.view"/> <category android:name="android.intent.category.browsable"/> <category android:name="android.intent.category.default"/> </intent-filter> <intent-filter> <data android:scheme="tencent "/> <action android:name="android.intent.action.view"/> <category android:name="android.intent.category.default"/> <category android:name="android.intent.category.browsable"/> </intent-filter>

23 </activity> <service android:name="com.papa91.pay.pa.service.floatwindowservice"/> 注 : 登录 :com.papa91.pay.pa.activity.paloginactivity 支付 :com.papa91.pay.pa.activity.paayactivity 提示界面 :com.papa91.pay.pa.activity.panoticedialogactivity 这两个 activity 可以根据需要选择横屏或者竖屏, 其他界面不要做更改 5.3 Key 声明请在 <application></application> 中配置相应值 <meta-data android:name="pa_app_key" android:value="qh97"/> <meta-data android:name="pa_app_private_key" android:value="se+mlqd-mv@y6^z+97"/> 6 开发者注意事项 1. 不要忘记在主 Activity 内调用 PPayCenter. init(context); 2. 不要忘记加 uses-permission 3. 不要忘记加 activity&service 声明 4. 编码为 UTF-8 5. SDK 工程在 eclipse 环境下, 必须和游戏主程放在同一文件夹下, 否则会引用失败 6. 遇到贴子详情打不开的问题请确认 assets 中的 entities-base.properties

24 entities-full.properties 是否存在在打包的 APK 中 7 附录支付结果通知接口和登录二次验证接口都可以在以下页面上找到相关代码和参数信息 8 老版本升 2.1 版本 library 依赖集成方式 1. 替换依赖工程 1.3 升 2.1 增加如下接口 2. 新增进入游戏接口 :PPayCenter.enterGame(roleName,district,server); 注 : 如果 IDE 是 eclipse, 则依赖工程中的 assets 目录下的资源不会自动打包到主工程内需要手动将该目录下的资源 copy 到主工程内直接 COPY 集成方式 1. 将所有资源 (assests res libs)copy 到主工程内 1.3 升 2.1 增加如下接口 2. 新增进入游戏接口 :PPayCenter.enterGame(roleName,district,server); 2.1 版本起可配置横屏或者竖屏界面登录 :com.papa91.pay.pa.activity.paloginactivity 支付 :com.papa91.pay.pa.activity.paayactivity 提示界面 :com.papa91.pay.pa.activity.panoticedialogactivity 这三个 activity 可以根据需要选择横屏或者竖屏, 其他界面不要做更改

DU Ad Platform_SDK 安卓接入指南 DU Ad Platform_SDK for Android 接入手册 ( 触发式广告 ) DUAd_SDK_Trigger v1.0 百度在线网络技术 ( 北京 ) 有限公司百度在线网络技术 ( 北京 ) 有限公司 - 1 -

DU Ad Platform_SDK 安卓接入指南 DU Ad Platform_SDK for Android 接入手册 ( 触发式广告 ) DUAd_SDK_Trigger v1.0 百度在线网络技术 ( 北京 ) 有限公司百度在线网络技术 ( 北京 ) 有限公司 - 1 - DU Ad Platform_SDK for Android 接入手册 ( 触发式广告 ) DUAd_SDK_Trigger v1.0-1 - 目录 1. 获取身份... 1 2. 加载与配置... 2 2.1 加载 SDK 文件... 2 2.2 配置 AndroidManifest.xml... 2 2.3 混淆代码... 3 3. 初始化... 4 4. 功能使用... 4 第 1 页共 1