0.0.1 • Published 11 months ago

wechat-backend-minigame v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
11 months ago

wechat-backend-minigame

微信小游戏服务端接口封装

Usage

const API = require('./lib')
const api = new API({
  appId: 'xxx',
  appSecret: 'xxxx'
})

api[method](...)

初始化 API 的 options 参数说明:

  • appId必需,小程序唯一凭证,即 AppID,可在「微信公众平台 - 设置 - 开发设置」页中获得。(需要已经成为开发者,且帐号没有异常状态)
  • appSecret必需,小程序唯一凭证密钥,即 AppSecret,获取方式同 AppID
  • midasOfferId,米大师分配的 offer_id
  • midasSecret 米大师密钥
  • baseURL,请求的基地址,如遇到异常,可以更换到备用服务器
  • timeout,请求的超时时间,默认为 40 秒
  • debug,是否输出请求日志,供内部开发调试使用

API Methods List

名称官方文档功能
midasCancelPaymidasCancelPaySandboxmidas.cancelPay取消订单
midasGetBalancemidasGetBalanceSandboxmidas.getBalance获取游戏币余额
midasPaymidasPaySandboxmidas.pay扣除游戏币
midasPresentmidasPresentSandboxmidas.present给用户赠送游戏币
getAccessTokenauth.getAccessToken获取小程序全局唯一后台接口调用凭据(access_token)
checkSessionKeyauth.checkSessionKey校验服务器所保存的登录态 session_key 是否合法
code2Sessionauth.code2Session登录凭证校验
msgSecChecksecurity.msgSecCheck检查一段文本是否含有违法违规内容
imgSecChecksecurity.imgSecCheck校验一张图片是否含有违法违规内容
removeUserStoragestorage.removeUserStorage删除已经上报到微信的key-value数据
setUserStoragestorage.setUserStorage上报用户数据后台接口
createActivityIdupdatableMessage.createActivityId创建被分享动态消息的 activity_id
setUpdatableMsgupdatableMessage.setUpdatableMsg修改被分享的动态消息
createQRCodewxacode.createQRCode获取小程序二维码,适用于需要的码数量较少的业务场景
getWxaCodewxacode.get获取小程序码,适用于需要的码数量较少的业务场景
getUnlimitedwxacode.getUnlimited获取小程序码,适用于需要的码数量极多的业务场景