小游戏SDK-1.3.0

公众号需要为SDK配置的可访问域名

测试：
https://wxmini-test.xxx.com,
https://ipregion-test.xxx.com（使用checkIP接口再添加，已废弃）
https://platform-test.xxx.com（使用checkIP接口再添加）

正式：
https://wxmini-log.xxx.com,
https://wxmini.xxx.com,
https://ipregion.xxx.com（使用checkIP接口再添加，已废弃）
https://platform.xxx.com（使用checkIP接口再添加）

SDK目录结构

--sdk.js

--sdk-conf.js

安装方法

把sdk.min.js 和 sdk-conf.js放入工程目录

使用

1. 在小游启动文件头部引入sdk 和 conf 文件
2. 初始化sdk
3. 调用sdk内方法

// 在小游启动文件头部引入sdk 和 conf 文件
let sdk = require("./hortor-sdk/sdk.min.js");
let conf = require('./hortor-sdk/sdk-conf.js')

// config 配置项详解
// conf.env = 'Test'                    // 必填 运行环境：测试Test 上线Prod，上线审核要把环境改为Prod
// conf.gameId = 'sdk-minigame-test'    // 必填 游戏ID，去平台后台创建
// conf.gameVersion = '1.0.1'           // 可选 当前游戏版本号 当要根据游戏版本使用IP检测时必填
// conf.shareData = { ... }             // 可选 默认的分享数据
// conf.getUserInfoBtn = { ... }        // 可选 默认的获取用户信息按钮的样式
// config.gameClubBtn = { ... }         // 可选 默认游戏圈按钮样式

...

// 初始化sdk
sdk.init(conf);

// 登陆
// sdk.login(...);

...
}

API列表

弱授权登录

sdk.weakLogin(onSuccess, onShowBtn)

强授权登录

sdk.login(onSuccess, onShowBtn)

解密弱授权登录

// 解密登录的用户信息由 sdk 解密 适用于没有后台的单机游戏
sdk.decodeWeakLogin(onSuccess, onShowBtn)

解密强授权登录

// 解密登录的用户信息由 sdk 解密 适用于没有后台的单机游戏
sdk.decodeLogin(onSuccess, onShowBtn)

所有用户登录参数详解

// 登录参数 onSuccess
function(user, error, checkedSession) {}

签名：字典序md5(secret=xxxtimestamp=xxxuserInfo=xxx)校验数据
用户信息解密：base64Decode(userInfo)，secret 作为key， AES256 PKCS7解密
secret请询问HortorGame对接人获取，注意保存

解密登录时 userInfo 直接返回明文

登录成功时 error 为 null

checkedSession基本没啥用

/* 
 * 登录参数 onShowBtn 示例代码
 * 1. onShowBtn调用的时机是由SDK判断的，游戏只需定义展示的样式
 * 2. 游戏控制按钮的展示，以及要一同展示的内容
 * 3. 点击后按钮的隐藏由游戏控制，并伴随自定义内容的隐藏
 */ 
function() {
  // 先获取 “获取用户信息按钮” 自行定义按钮类型及样式
  let button = sdk.getGetUserInfoBtn({
    type: 'text',
    text: '获取用户信息',
    style: {
        left: 10,
        top: 76,
        width: 200,
        height: 40,
        lineHeight: 40,
        backgroundColor: '#ff0000',
        color: '#ffffff',
        textAlign: 'center',
        fontSize: 16,
        borderRadius: 4
    }
  }, function(data, err, button) {
    // 授权成功
    if (data) {
      // 隐藏 button
      button.hide()
    }
  })

  // 然后绑定获取用户信息后回调，用户拒绝和允许都走这个方法，拒绝时返回res 
  // {
  //    errMsg: "getUserInfo:fail auth deny"
  // } 
  // button的隐藏由游戏控制，
  // button.onTap((res) => {
     // 再用这个方法需要自己判断 res 
     // 隐藏 button
     // button.hide()
  // })

  // 最后展示button，并执行自定义的其他展示逻辑
  button.show()
}

配置获取用户信息按钮

登陆按钮样式配置API

sdk.getGetUserInfoBtn(config, callback)

支付接口

sdk.pay(orderData, callback)

二维码支付（测试版，不建议使用）

sdk.QRCodePay(orderData, callback)

主动唤起分享

sdk.shareAppMessage(obj)
// 示例
sdk.shareAppMessage({
  title: '分享:' + channel,
  query: 'channel=' + channel + '&shareConfigId=' + shareConfigId,
  success: (resp) => {
    console.log('sdk.shareAppMessage:', resp)
  }
})

用户点击右上角唤起分享

sdk.onShareAppMessage(()=>{
return shareObj
})

如果未注册被动分享回调则使用conf里默认分享模版

获取分享信息Gid

sdk.getShareInfo({
shareTicket: option.shareTicket,
  userId: 'xxxx',
  gameId:conf.gameId
}, callBack)

获取小程序码中的自定义参数

//异步
sdk.getMiniCode((resp) => {
  console.log("getQRQuery:", resp)
})
//同步
sdk.getMiniCodeSync()

防沉迷提醒

sdk.checkRest(callback, setting)

// 示例
sdk.checkRest(function() {
   console.log('玩家需要休息')
})

IP区域检测（是否是可访问）

如果调用此接口需要添加可访问域名（request）：
测试：https://platform-test.xxx.com
正式：https://platform.xxx.com

在 sdk-conf文件中（即 sdk配置参数）配置游戏版本号 gameVersion 用于判断不同版本的游戏是否开启 IP 检测
在游戏后台设置不同版本的游戏检测配置 由 gameVersion 区分
在游戏后台设置不同场景的检测配置，由 interfaceId 区分

sdk.checkIP('interfaceId', callback)

// 示例 ip 后端会根据请求自动判断
sdk.checkIP( (res) => { console.log('checkIP: ', res) });

调起客服

sdk.customerService(obj)

加密登录（1.2.7）

调用加密登录需要引用 sdk.encode.min.js 文件（不需要 sdk.min.js）
不需要加密登录引用 sdk.min.js 文件即可，此时调用加密登录控制台会警告此SDK不支持加密登录
特殊版本sdk，比其他版本大，传参和正常登录一样，与服务器传输的code会加密，返回给游戏的用户信息参数中会有明文code；游戏端要拿code与后端校验

// 加密强授权
sdk.encodeLogin(next, onBtnshow)

// 加密弱授权
sdk.encodeWeakLogin(next, onBtnshow)

获取默认配置（1.3.1开始废弃）

// 获取默认配置信息
sdk.getDefaultSet(interfaceId, function(data) {
  console.log(data)
})

上报用户托管数据

// 上报用户托管数据到微信云端，用于排行榜展示
sdk.setUserCloudStorage(obj)

游戏圈图标展示

// 展示游戏圈入口图标，只支持设置一个游戏圈图标，
sdk.gameClub.show({
  icon: 'green',
  style: {
      left: 10,
      top: 76,
      width: 40,
      height: 40
  },
})

// 隐藏游戏圈图标
sdk.gameClub.close()

// 清除游戏圈图标
sdk.gameClub.clear()

视频广告接口

成为流量主后才能向微信申请广告权限
微信要求在展示广告之前要判断该广告数据是否可以加载 即调用 sdk.checkVideoAd

// 验证是否广告是否可用
sdk.checkVideoAd(obj)

// 展示视频广告
sdk.showVideoAd(obj)

// 验证是否广告是否可用
sdk.checkVideoAd({ adUnitId, success, error })

// 展示视频广告
sdk.showVideoAd({ adUnitId, onShow, onClose, onError })

错误上报

sdk.errorLog(data)