时代首游手游SDK

文档目的

1.提供给时代首游手游合作伙伴们规范接入文档。
2.指导公司内部游戏接入SDK

读者对象

时代首游手游合作伙伴技术部门android技术人员及管理人员。

接入流程

1.接入准备：新游接入前，请先向我方商务人员申请参数appid和appkey，并获取sdk资源包。
2.技术接入：由贵方技术人员进行技术对接。
注：目前sdk只支持android端接入。

增加权限声明

<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
<uses-permission android:name="android.permission.INTERNET" />
<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.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_MOCK_LOCATION" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<!-- 对外部存储设备的写入权限 -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<!-- 对外部文件的写入和删除权限 -->
<uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS" />

注意：权限声明应在application标签外

增加Activity、Service、Receiver声明

	<activity
			android:name="com.zqgame.sdk.LoginDialogDefault"
			android:theme="@style/login_dialog"
			android:configChanges="orientation|keyboard|keyboardHidden|navigation|screenSize"
			android:windowSoftInputMode="adjustUnspecified|stateHidden" >
	</activity>
	<!-- 注意:如果你的系统版本高于13,请添加 screenSize 在 LoginAnimation configChanges中-->
	<activity
			android:name="com.zqgame.sdk.LoginAnimation"
			android:configChanges="orientation|keyboard|keyboardHidden" >
	</activity> 
	<activity
			android:name="com.zqgame.sdk.PayActivity"
			android:configChanges="orientation|keyboard|keyboardHidden|navigation|screenSize"
			android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"
			android:windowSoftInputMode="adjustUnspecified|stateHidden" >
	</activity>
	<activity
			android:name="com.zqgame.sdk.WebViewActivity"
			android:configChanges="orientation|keyboard|keyboardHidden|navigation|screenSize"
			android:theme="@android:style/Theme.NoTitleBar.Fullscreen"
			android:windowSoftInputMode="adjustUnspecified|stateHidden" >
	</activity>
	<activity
			android:name="com.zqgame.sdk.GameCenterActivity"
			android:configChanges="orientation|keyboard|keyboardHidden|navigation|screenSize"
			android:windowSoftInputMode="adjustUnspecified|stateHidden" >
	</activity>
	<activity
			android:name="com.zqgame.sdk.OnlineServiceActivity"
			android:configChanges="orientation|keyboard|keyboardHidden|navigation|screenSize"
			android:windowSoftInputMode="adjustUnspecified|stateHidden" >
	</activity>
	<activity
			android:name="com.zqgame.sdk.PersonalActivity"
			android:launchMode="singleTask" >
	</activity>
	<activity
			android:name="com.zqgame.sdk.BindPhoneActivity"
			android:launchMode="singleTask" >
	</activity>
	<activity
			android:name="com.zqgame.sdk.BindEmailActivity"
			android:launchMode="singleTask" >
	</activity>
	<activity
			android:name="com.zqgame.sdk.ModifyPwdActivity"
			android:launchMode="singleTask" >
	</activity>       

	<activity
			android:name="com.zqgame.sdk.PaySelectActivity"
			android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" >
	</activity>
	<!-- 支付宝 -->
	<activity
			android:name="com.alipay.sdk.app.H5PayActivity"
			android:configChanges="orientation|keyboardHidden|navigation"
			android:exported="false"
			android:screenOrientation="behind" >
	</activity>
	<activity
			android:name="com.alipay.sdk.auth.AuthActivity"
			android:configChanges="orientation|keyboardHidden|navigation"
			android:exported="false"
			android:screenOrientation="behind" >
	</activity>

注意：声明应在application标签内

引用lib工程

a.将zip包中的ZQGameSDK_lib引入到eclipse工程
具体方法：File->import->General->Existing Projects into Workspace

b.游戏工程中选择依赖ZQGameSDK_lib工程
具体方法：游戏项目project 的properties-->android里library 点击Add

如果不使用Android Lib工程，可以将ZQGameSDK_lib里libs下的jar包及res下的资源拷贝过去）
c代码混淆，不要混淆jar包中的类

拷贝配置文件

将zip包中的assets里的文件拷贝到游戏Android工程的assets目录下。

注意：无需做任何更改，直接拷贝就行

代码

请确定在游戏的主Activity中调用初始化接口ZQGame.initSdk

@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		appId = “xxx”;
		appKey = “xxxx”;
		ZQGame.initSdk(this, appId, appKey, 2, this);
	}

请求参数列表

initFinish初始化完成回调接口返回参数列表

代码

在游戏各个Activity（除闪屏Activity外）生命周期中调用SDK生命周期接口

public void onStop() {
	    super.onStop();
	     ZQGame.onStop(this);
	}
	public void onDestroy() {
	    super.onDestroy();
	    ZQGame.onDestroy(this);
	}
	public void onResume() {
	    super.onResume();
	    ZQGame.onResume(this);
	}
	public void onPause() {
	    super.onPause();
	    ZQGame.onPause(this);
	}
	public void onRestart() {
	    super.onRestart();
	    ZQGame.onRestart(this);
	}
	protected void onNewIntent(Intent intent) {
	    super.onNewIntent(intent);
	    ZQGame.onNewIntent(this,intent);
	}
	protected void onActivityResult(int requestCode, int resultCode,
	    Intent data) {
	    super.onActivityResult(requestCode, resultCode, data);
	    ZQGame.onActivityResult(this,requestCode,resultCode, data);
	}

代码

在游戏各个Activity（除闪屏Activity外）生命周期中调用SDK生命周期接口

ZQGame.login(this, this);

请求参数列表

返回 参数列表与LoginData

LoginData说明

当同一账号在，不同设备登陆时， 当前账号将被强制登出。Cp方应该在onSessionInvalid回调接口中实现游戏的注销，返回到游戏初始登陆界面。

代码

@Override
	public void onSessionInvalid(int code, LoginData ld) {
		Log.d(TAG, "登陆失效");
		if( code == ZQGame.SUCCESS) {
			//注销游戏逻辑
		}
		
	}

游戏在创建角色之后，需要调用ZQGame.createRole接口提交角色的一些基本信息。

代码

playerData.setServerNo("1");
_playerData.setServerName("测试一服");
_playerData.setRoleId("123");
_playerData.setRoleName("黑暗森林");
_playerData.setPartyName("利剑联盟");
_playerData.setLevel("12");
ZQGame.createRole(this, _playerData); 

参数说明

游戏在创建角色之后，需要调用ZQGame.enterGame(this, _playerData);接口提交角色的一些基本信息。

代码

ZQGame.enterGame(this, _playerData); 

参数说明

与创建角色接口一致。

游戏在创建角色之后，需要调用ZQGame.enterGame(this, _playerData);接口提交角色的一些基本信息。

代码

ZQGame.userUpLevel(this, _playerData);

参数说明

与创建角色接口一致。

代码

_payData.setAmount(100);
			_payData.setGameMoneyAmount(10);
			_payData.setGameMoneyName("钻石");
			_payData.setProductId("1");
			_payData.setGameOrderId("20150923165500233300");
			_payData.setProductName("6元礼包");
			_payData.setUserBalance("0");
			_payData.setUserId(uid);
			_payData.setVipLevel("0");
			_payData.setPtOrderId("20150923165500233300");
			ZQGame.pay(this, _payData, this);

请求参数说明

回调接口payFinish返回参数

代码

ZQGame.showToolBar(this);

接口说明

此接口，需要游戏方用于调出游戏浮标。 登陆成功后将会默认调出

代码

ZQGame.closeToolBar(this);

接口说明

此接口，需要游戏方用于关闭游戏浮标。

代码

ZQGame.logout(this,this);

接口说明

此接口，用于游戏切换、注销账号。 参数为 Context和ZQGameSdkListener. 需要实现回调方法 logoutFinish(int code), ZQGame.SUCCESS 成功 ZQGame.FAILED失败 ZQGame.CANCEL 取消 ZQGame.UNKNOWN 未知

代码

ZQGame.exitGame(this, this);

接口说明

此接口，需要游戏方,退出游戏的时候调用此接口. 需要实现exitGame(int code)回调。

实名认证

用户在使用SDK提供的登录能力时，SDK如检测到用户未进行实名认证，会弹窗提示用户进行实名认证并中断登录流程。

时长防沉迷

SDK根据《国家新闻出版署关于进一步管理切实防止未成年人沉迷网络游戏通知》，需要游戏实现以下限制：

第一条：所有网络游戏企业仅可在周五、周六、周日和法定节假日每日20时至21时向未成年人提供1小时网络游戏服务，其他时间均不得以任何形式向未成年人提供网络游戏服务。

第二条：所有网络游戏用户必须使用真实有效身份信息进行游戏账号注册并登录网络游戏，网络游戏企业不得以任何形式（含游客体验模式）向未实名注册和登录的用户提供游戏服务

未成年人支付限制

使用SDK支付能力的游戏，未成年支付限制由SDK统一处理，游戏方不需要额外开发。如果用户达到了防沉迷充值限制，在进行游戏充值时，会弹窗提示用户无法充值，游戏开发者也会收到支付失败的回调。

消费限制：
游戏内未满8周岁的用户，不提供游戏付费服务；8周岁以上未满16周岁的用户，单次充值金额不得超过50元人民币，每月充值金额累计不得超过200元人民币；16周岁以上未满18周岁的用户，单次充值金额不得超过100元人民币，每月充值金额累计不得超过400元人民币。

登陆验证（必接）

测试接口：http://sdk.zqbconnect.com/(app_id)/sdk/login_request

请求方法：GET

参数：（app_id,app_key接入时向我方申请）

返回结果：json

Data字段：

5.2创建支付订单（必接）

测试接口：http://sdk.zqbconnect.com/(app_id)/sdk/create_order
请求方法：GET
参数：（app_id,app_key接入时向我方申请）

返回结果：json

Data字段：

支付回调（必接）

接口：游戏方提供
请求方法：GET
参数：

返回：游戏方接收到回调后需返回SUCCESS

签名

将所有值按参数字母顺序排序拼接：(空值不参与签名，所有字符串需utf8编码)
如：user_id=’u1001x’, session=’dsfrgzfggjfgafdg’, ext=’6’, 拼接后的字符串：’6dsfrgzfggjfgafdgu1001x’ 最后接上我方app_key,计算MD5值 sign=MD5(‘%s%s’%(‘6dsfrgzfggjfgafdgu1001x’,app_key))