一、SDK说明

1.1 接入Demo地址

http://gameyt.quicksdk.net/test/h5

1.2 登录流程

当玩家请求SDK游戏链接时,SDK以iFrame加载游戏页面
SDK加载游戏页面时会附带GET参数,游戏获取GET参数.GET参数中包含了用户的UID信息,以及是否为游客模式.
游戏可以根据自身逻辑选择是否允许游客玩家游戏,若不允许可主动调用登录接口.
每当玩家切换帐号时SDK会重新加载iframe以更新传递给游戏的GET参数
游戏服务端根据登录处理流程验证SDK加载游戏页面时附带的用户信息后，无需接入服务端验证用户信息接口

1.3 支付流程

游戏通过JS API调用支付接口,SDK会弹出支付页面
当玩家支付完成后,SDK服务器会向游戏服务器发送发货通知.

游戏处理发货通知向玩家发送道具,购买完成

二、接入步骤

2.1 添加SDK

引入SDK JS类库 (xxx.com为域名，请联系贵方运营获取,获取之后替换即可) 

2.2 SDK初始化（必接）

函数 : 

H5SDK.init('41342366340644380357761326798063');   //参数为productCode

功能：使用产品id，初始化SDK。
参数：productCode，产品id，必填，对接商务提供。

2.3 登录接口(选接)

函数 : 

H5SDK.login(function(loginNotify){
console.log(loginNotify);
});
功能：进入用户登录页面。需要在初始化成功之后调用，否则调用无效。游戏可以调用此接口显示一个用户登录界面。
loginNotify中将返回玩家登录的信息.失败时为失败原因.
成功后刷新页面.重新加载游戏.
通知示例:Object {status: false, data: "", message: "账号或密码错误"}

2.4 处理用户登录

游戏链接被加载时SDK会向游戏链接添加GET参数

参数	含义
uid	玩家UID
username	玩家用户名
sign	签名串，游戏需验证签名是否正确,不正确拒绝登录
isLogin	是否游客；0游客，1正式帐号
time	时间戳
marketTag	投放标示
utype	游客模式注册的账号，是否已绑定邮箱。0未绑定，1已绑定
bindFB	是否绑定Facebook。0未绑定，1已绑定
bindGoogle	是否绑定Google。0未绑定，1已绑定
bindApple	是否绑定Apple。0未绑定，1已绑定

处理逻辑：

UID即是玩家的唯一表示,游戏应获取UID匹配玩家角色信息.

使用uid前需进行签名验证,验证方法.
本地计算md5签名 md5(uid+’&’ + username + ‘&’ + time + “&” + callbackkey)
若本地签名与GET参数的sign一致,则签名通过.不一致则拒绝玩家登录.
游戏使用UID进行游戏后续逻辑
注:callbackkey由SDK后台分配，可通过商务获取

2.5 退出登录

当玩家退出登录时，SDK会重新加载游戏链接，更新链接上的GET参数

2.6 充值

函数 : 

var orderInfo = new Object();
orderInfo.productCode = “05425578266356246482673853629430”;
orderInfo.uid = “uid”;
orderInfo.userRoleId = 'roleId1';
orderInfo.userRoleName = '小朋友';
orderInfo.userServer = '内测1区';
orderInfo.userLevel = 1;
orderInfo.cpOrderNo = 'cpOrderNo000001';
orderInfo.amount = '0.01';
orderInfo.subject = '大袋钻石';
orderInfo.desc = '一大袋钻石60个';
orderInfo.callbackUrl = '';
orderInfo.extrasParams = '';
orderInfo.goodsId = '';
orderInfo.count = 60;
orderInfo.quantifier = '个'; 
var orderInfoJson = JSON.stringify(orderInfo);
H5SDK.pay(orderInfoJson,function(payStatusObject){
 console.log('GameDemo:下单通知' + JSON.stringify(payStatusObject));
});

orderInfo对象如下:

字段	类型	说明
productCode	必传	后台自动分配的参数
uid	必传	渠道UID
username	选传	渠道username
userRoleId	必传	游戏内角色ID
userRoleName	必传	游戏角色
userServer	必传	角色所在区服
userLevel	必传	角色等级
cpOrderNo	必传	游戏内的订单,服务器通知中会回传
amount	必传	购买金额
count	必传	购买商品个数
quantifier	必传	购买商品单位，如，个
subject	必传	道具名称
desc	选传	道具描述
callbackUrl	选传	服务器通知地址，订单支付成功后SDK向游戏通知发货的地址。可在SDK后台配置，后台配置了则以后台配置的地址为最终通知地址
extrasParams	选传	透传参数,服务器通知中原样回传。扩展字段请勿传特殊符号（如单引号、双引号等），如果无法避免建议先进行base64编码后再传
goodsId	必传	商品ID

回调函数payStatusObject对象中status为true时为支付成功.注客户端的通知应仅仅作为UI展示,发货需以最终的服务器通知为准,且发送金额需为服务器通知中的告知的金额.
服务器通知接口参见《服务器对接文档》

2.7 角色上报

函数 : 
var roleInfo = new Object();
roleInfo.serverName = '内测1区';
roleInfo.userRoleName = '小怪物';
roleInfo.userRoleId = 'roleId1';
roleInfo.userRoleBalance = 1000;
roleInfo.vipLevel = 1;
roleInfo.userRoleLevel = 1;
roleInfo.partyName = '行会名称';
roleInfo.uid ="uid"; 
var roleInfoJson = JSON.stringify(roleInfo); 
H5SDK.uploadGameRoleInfo(roleInfoJson,function(response){
if(response.status){
…
}else{
…
}
}); 

roleInfo对象如下:

字段	类型	说明
uid	必传	SDK账号UID
serverName	选传	区服名称
userRoleName	必传	游戏角色
userRoleBalance	选传	角色游戏内货币余额
userRoleId	必传	角色ID
userRoleLevel	必传	角色等级
vipLevel	选传	角色VIP等级
partyName	选传	公会/社团名称

选传字段的值可以为空字符串，但是字段必须传

回调函数response对象中status为true时为上报角色成功.

2.8 用户绑定邮箱

函数 : 

var dataInfo = new Object(); 
var dataInfoJson = JSON.stringify(dataInfo); 
H5SDK.bindMail(dataInfoJson,function(response){
 if(response.status){
 …
 }else{
 …
 }
}); 

dataInfo对象目前无需传参数，直接创建空对象即可 

函数回调参数对象如下:

字段	类型	说明
status	必传	0:失败 1:成功
message	必传	接口请求结果消息
userData	选传	邮箱绑定成功时会返回此对象
userData.username	选传	邮箱绑定成功时返回的用户名

2.9 事件埋点上报

函数 : 

var dataInfo = new Object(); 
var dataInfo.evtAction=”xxxxx”;
evtParams.evtExtParams = {
 "value":"0.99",
 "currency":"USD"
 };
var dataInfoJson = JSON.stringify(dataInfo); 
H5SDK.reportEvent(dataInfoJson); 

dataInfo对象参数如下:

字段	类型	说明
evtAction	必传	自定义埋点事件名称
evtExtParams	选传	自定义事件扩展参数对象，游戏上报什么SDK原样上报给统计工具

注意：如果有开启事件上报统计，必须要上报purchase事件

purchase事件dataInfo对象参数如下：

字段	类型	说明
evtAction	必传	取固定值：purchase
evtExtParams	必传	扩展对象参数如下： value：商品价格 currency：币种 cpOrderNo:游戏订单号 goodsId:商品ID， goodsSubject:商品名称 evtToken：adjust事件识别码，当事件工具有adjust时必传

事件上报函数无回调

2.10 用户绑定社交账号

注意：目前仅支持Facebook

函数 : 
var dataInfo = new Object(); 
dataInfo.openType=6;
var dataInfoJson = JSON.stringify(dataInfo); 
H5SDK.bindSNS(dataInfoJson,function(response){
if(response.status){
…
}else{
…
}
}); 

dataInfo参数如下：

字段	类型	说明
openType	必传	绑定类型，取值如下： 6：Facebook

函数回调参数对象如下:

字段	类型	说明
status	必传	0:失败 1:成功
message	必传	接口请求结果消息

2.11 删除玩家账号

函数 : 
var evtParams = new Object();
var evtParamsJson = JSON.stringify(evtParams);
H5SDK.doDeleteAccount(evtParamsJson,function(response){
console.log(response);
}); 

函数回调参数对象如下:

字段	类型	说明
status	必传	0:失败 1:成功

2.12 其他注意事项

由于游戏需要和SDK通信，故游戏页面需要发送允许跨域的HTTP Header : Access-Control-Allow-Origin