wechat-backend-miniprogram

0.0.1 • Public • Published

wechat-backend-miniprogram

微信小程序服务端接口封装

Usage

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

api[method](...)

初始化 API 的 options 参数说明:

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

API Methods List

名称 官方文档 功能
code2Session auth.code2Session 登录凭证校验
getPaidUnionId auth.getPaidUnionId 用户支付完成后,获取该用户的 UnionId,无需用户授权
getAccessToken auth.getAccessToken 获取小程序全局唯一后台接口调用凭据(access_token)
getDailyRetain analysis.getDailyRetain 获取用户访问小程序日留存
getMonthlyRetain analysis.getMonthlyRetain 获取用户访问小程序月留存
getWeeklyRetain analysis.getWeeklyRetain 获取用户访问小程序周留存
getDailyVisitTrend analysis.getDailyVisitTrend 获取用户访问小程序数据日趋势
getMonthlyVisitTrend analysis.getMonthlyVisitTrend 获取用户访问小程序数据月趋势
getWeeklyVisitTrend analysis.getWeeklyVisitTrend 获取用户访问小程序数据周趋势
getUserPortrait analysis.getUserPortrait 获取小程序新增或活跃用户的画像分布数据
getVisitDistribution analysis.getVisitDistribution 获取用户小程序访问分布数据
getVisitPage analysis.getVisitPage 访问页面
getDailySummary analysis.getDailySummary 获取用户访问小程序数据概况
getTempMedia customerServiceMessage.getTempMedia 获取客服消息内的临时素材
sendCustomMessage customerServiceMessage.send 发送客服消息给用户
setTyping customerServiceMessage.setTyping 下发客服当前输入状态给用户
uploadTempMedia customerServiceMessage.uploadTempMedia 把媒体文件上传到微信服务器
addTemplate templateMessage.addTemplate 组合模板并添加至帐号下的个人模板库
deleteTemplate templateMessage.deleteTemplate 删除帐号下的某个模板
getTemplateLibraryById templateMessage.getTemplateLibraryById 获取模板库某个模板标题下关键词库
getTemplateLibraryList templateMessage.getTemplateLibraryList 获取小程序模板库标题列表
getTemplateList templateMessage.getTemplateList 获取帐号下已存在的模板列表
sendTemplageMessage templateMessage.send 发送模板消息
sendUniformMessage uniformMessage.send 下发小程序和公众号统一的服务消息
createActivityId updatableMessage.createActivityId 创建被分享动态消息的 activity_id
setUpdatableMsg updatableMessage.setUpdatableMsg 修改被分享的动态消息
applyPlugin pluginManager.applyPlugin 向插件开发者发起使用插件的申请
getPluginDevApplyList pluginManager.getPluginDevApplyList 获取当前所有插件使用方(供插件开发者调用)
getPluginList pluginManager.getPluginList 查询已添加的插件
setDevPluginApplyStatus pluginManager.setDevPluginApplyStatus 修改插件使用申请的状态(供插件开发者调用)
unbindPlugin pluginManager.unbindPlugin 删除已添加的插件
addNearbyPOI nearbyPoi.add 添加地点
delNearbyPOI nearbyPoi.delete 删除地点
getNearbyPOIList nearbyPoi.getList 查看地点列表
setNearbyShowStatus nearbyPoi.setShowStatus 展示/取消展示附近小程序
createQRCode wxacode.createQRCode 获取小程序二维码,适用于需要的码数量较少的业务场景
getWxaCode wxacode.get 获取小程序码,适用于需要的码数量较少的业务场景
getUnlimited wxacode.getUnlimited 获取小程序码,适用于需要的码数量极多的业务场景
imgSecCheck security.imgSecCheck 校验一张图片是否含有违法违规内容
msgSecCheck security.msgSecCheck 检查一段文本是否含有违法违规内容
addOrder logistics.addOrder 生成运单
cancelOrder logistics.cancelOrder 取消运单
getAllDelivery logistics.getAllDelivery 获取支持的快递公司列表
getOrder logistics.getOrder 获取运单数据
getPath logistics.getPath 查询运单轨迹
getPrinter logistics.getPrinter 获取打印员
getQuota logistics.getQuota 获取电子面单余额
updatePrinter logistics.updatePrinter 更新打印员
getContact logistics.getContact 获取面单联系人信息
previewTemplate logistics.previewTemplate 预览面单模板
updateBusiness logistics.updateBusiness 更新商户审核结果
updatePath logistics.updatePath 更新运单轨迹
verifySignature soter.verifySignature SOTER 生物认证秘钥签名验证

Readme

Keywords

none

Package Sidebar

Install

npm i wechat-backend-miniprogram

Weekly Downloads

0

Version

0.0.1

License

MIT

Unpacked Size

51.2 kB

Total Files

7

Last publish

Collaborators

  • xovel