SDK介绍
- 快手小游戏SDK提供JS文件,小游戏中直接引入JS文件即可。
- SDK为快手小游戏提供功能接口包括:初始化、登录、支付、创角。
注意事项
- 接口参数大小写敏感
- request 和 response的编码格式均为 UTF-8
前期准备
1.对接技术人员仔细阅读对接文档
2.获取sdk文件, 下载
3.提供支付回调地址
4.获取sdk平台参数
字段 | 描述 |
---|---|
app_id | (游戏ID) |
client_id | (客户端ID) |
client_key | (客户端KEY) |
接入步骤
- 复制qfkssdk文件到小游戏工程中 (qfkssdk文件中包含sdk 的js文件)
引用qfkssdk.min.js文件,并且传入从SDK平台获取到的参数:
import qfkssdk from './xx/qfkssdk/qfkssdk.min.js' var qfsdk = new qfkssdk(app_id,client_id,client_key,debug)
构建SDK实例必须保证参数正确,否则导致游戏数据异常。
游戏启动时调用初始化接口,如果游戏需要自动登录,则在初始化完成回调中调用登录接口。
debug: 是否为调试模式,true为调试模式,默认为true
动态设置域名 (注:设置域名必须在调用SDK接口之前)
qfsdk.setBaseHost(https://sdk.duojiao.tv/)
动态设置icon图片(填线上地址,如果不需要用客服方式支付可以不填)
qfsdk.setBaseHost("https://.....)
- SDK接入时, 必须确保登录接口在初始化接口完成后调用
接口调用
1. 初始化
qfsdk.initSdk({
success(res) {
console.log("初始化成功" + res.status)
// 在初始化回调中调用登录接口
qfsdk.loginSdk({
success(res) {
console.log(res);
},
fail(err) {
console.log(err);
}
});
},
fail(err) {
console.log(err);
},
});
调用初始化必须确保:
1.游戏启动时调用
2. 登录
调用登录必须确保:
1.SDK初始化完成,否则将无法登录。
2.如需要游戏启动自动登录,则在初始化success回调里面调用此接口
qfsdk.loginSdk({ success(res) { console.log(res); }, fail(err) { console.log(err); } });
3. 购买道具
//购买道具
qfsdk.submitOrder({
money: moneyValue,
yxbNum: moneyValue * 10,
serverName: '天行九歌',
serverId: '1',
roleName: '熊大',
roleId: '199',
productId: '产品IDID',
productName: '元宝',
productDes: '元宝100个',
attach: 'CP订单号',
success: function(res) {
console.log( res);
},
fail: function(err) {
console.log(err);
},
});
购买道具接口只实现下单逻辑,下单完成后跳转客服页面进行支付。
4. 创角/角色升级
//创建角色
qfsdk.createRole({
serverName: '测试一区',
serverId: '101',
roleName: '昙花一现',
roleId: '210',
roleGrade: '30',
success: function (res) {
console.log( res);
},
fail: function (err) {
console.log( err);
},
});
为了SDK平台更好的获取有用数据,所以游戏接入时务必接入此接口。
4. 广告事件上报
//事件上报
qfsdk.adEvent({
success: function (res) {
console.log( res);
},
fail: function (err) {
console.log( err);
},
});
根据实际需求接入,
接口说明
1.初始化
qfsdk.initSdk(Object object)
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
success | function | 否 | 接口调用成功回调函数 | |
fail | function | 否 | 接口调用失败回调函数 |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
status | int | 状态码,为1初始化成功,为0初始化失败 |
msg | string | 文字描述 |
data | JSON | 返回数据 |
object.fail 回调函数
参数
Object err
返回请求失败错误信息
2.登录
qfsdk.loginSdk(Object object)
参数
Object object
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
success | function | 否 | 接口调用成功回调函数 |
fail | function | 否 | 接口调用失败回调函数 |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
status | int | 状态码,为1登录成功,为0登录失败 |
msg | string | 文字描述 |
data | JSON | 返回数据 |
res.data 的结构
属性 | 类型 | 说明 |
---|---|---|
mem_id | String | 用户ID |
token | string | 用户token |
object.fail 回调函数
参数
Object err
返回请求失败错误信息
3.购买道具
qfsdk.submitOrder(Object object)
参数
Object object
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
money | String | 是 | 商品金额 |
yxbNum | int | 是 | 元宝数量 |
serverName | String | 是 | 区服名称 |
serverId | String | 是 | 区服ID(必传) |
roleName | String | 是 | 角色名称 |
roleId | String | 是 | 角色ID(必传) |
productId | String | 是 | 产品ID |
productName | String | 是 | 商品名称 |
productDes | String | 是 | 商品描述 |
attach | String | 是 | 扩展参数,一般传CP订单号 |
success | function | 否 | 接口调用成功回调函数 |
fail | function | 否 | 接口调用失败回调函数 |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
status | int | 状态码,为1下单成功,为0下单失败 |
msg | string | 文字描述 |
data | JSON | 返回数据 |
res.data 的结构
属性 | 类型 | 说明 |
---|---|---|
b | String | 订单号 |
object.fail 回调函数
参数
Object err
返回请求失败错误信息
3.创角/角色升级
qfsdk.createRole(Object object)
参数
Object object
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
serverName | String | 是 | 区服名称 |
serverId | String | 是 | 区服ID |
roleName | String | 是 | 角色名称 |
roleId | String | 是 | 角色ID |
roleGrade | String | 是 | 角色等级 |
success | function | 否 | 接口调用成功回调函数 |
fail | function | 否 | 接口调用失败回调函数 |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
status | int | 状态码,为1创角成功 |
msg | string | 文字描述 |
data | JSON | 返回数据 |
object.fail 回调函数
参数
Object err
返回请求失败错误信息
4.广告事件上报
qfsdk.adEvent(Object object)
参数
Object object
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
eventType | int | 是 | 事件类型 |
success | function | 否 | 接口调用成功回调函数 |
fail | function | 否 | 接口调用失败回调函数 |
事件类型:1=看完广告事件
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
status | int | 状态码,为1事件上报成功 |
msg | string | 文字描述 |
data | JSON | 返回数据 |
object.fail 回调函数
参数
Object err
返回请求失败错误信息