0.0.1 • Published 11 months ago

wechat-backend-miniprogram v0.0.1

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

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

名称官方文档功能
code2Sessionauth.code2Session登录凭证校验
getPaidUnionIdauth.getPaidUnionId用户支付完成后,获取该用户的 UnionId,无需用户授权
getAccessTokenauth.getAccessToken获取小程序全局唯一后台接口调用凭据(access_token)
getDailyRetainanalysis.getDailyRetain获取用户访问小程序日留存
getMonthlyRetainanalysis.getMonthlyRetain获取用户访问小程序月留存
getWeeklyRetainanalysis.getWeeklyRetain获取用户访问小程序周留存
getDailyVisitTrendanalysis.getDailyVisitTrend获取用户访问小程序数据日趋势
getMonthlyVisitTrendanalysis.getMonthlyVisitTrend获取用户访问小程序数据月趋势
getWeeklyVisitTrendanalysis.getWeeklyVisitTrend获取用户访问小程序数据周趋势
getUserPortraitanalysis.getUserPortrait获取小程序新增或活跃用户的画像分布数据
getVisitDistributionanalysis.getVisitDistribution获取用户小程序访问分布数据
getVisitPageanalysis.getVisitPage访问页面
getDailySummaryanalysis.getDailySummary获取用户访问小程序数据概况
getTempMediacustomerServiceMessage.getTempMedia获取客服消息内的临时素材
sendCustomMessagecustomerServiceMessage.send发送客服消息给用户
setTypingcustomerServiceMessage.setTyping下发客服当前输入状态给用户
uploadTempMediacustomerServiceMessage.uploadTempMedia把媒体文件上传到微信服务器
addTemplatetemplateMessage.addTemplate组合模板并添加至帐号下的个人模板库
deleteTemplatetemplateMessage.deleteTemplate删除帐号下的某个模板
getTemplateLibraryByIdtemplateMessage.getTemplateLibraryById获取模板库某个模板标题下关键词库
getTemplateLibraryListtemplateMessage.getTemplateLibraryList获取小程序模板库标题列表
getTemplateListtemplateMessage.getTemplateList获取帐号下已存在的模板列表
sendTemplageMessagetemplateMessage.send发送模板消息
sendUniformMessageuniformMessage.send下发小程序和公众号统一的服务消息
createActivityIdupdatableMessage.createActivityId创建被分享动态消息的 activity_id
setUpdatableMsgupdatableMessage.setUpdatableMsg修改被分享的动态消息
applyPluginpluginManager.applyPlugin向插件开发者发起使用插件的申请
getPluginDevApplyListpluginManager.getPluginDevApplyList获取当前所有插件使用方(供插件开发者调用)
getPluginListpluginManager.getPluginList查询已添加的插件
setDevPluginApplyStatuspluginManager.setDevPluginApplyStatus修改插件使用申请的状态(供插件开发者调用)
unbindPluginpluginManager.unbindPlugin删除已添加的插件
addNearbyPOInearbyPoi.add添加地点
delNearbyPOInearbyPoi.delete删除地点
getNearbyPOIListnearbyPoi.getList查看地点列表
setNearbyShowStatusnearbyPoi.setShowStatus展示/取消展示附近小程序
createQRCodewxacode.createQRCode获取小程序二维码,适用于需要的码数量较少的业务场景
getWxaCodewxacode.get获取小程序码,适用于需要的码数量较少的业务场景
getUnlimitedwxacode.getUnlimited获取小程序码,适用于需要的码数量极多的业务场景
imgSecChecksecurity.imgSecCheck校验一张图片是否含有违法违规内容
msgSecChecksecurity.msgSecCheck检查一段文本是否含有违法违规内容
addOrderlogistics.addOrder生成运单
cancelOrderlogistics.cancelOrder取消运单
getAllDeliverylogistics.getAllDelivery获取支持的快递公司列表
getOrderlogistics.getOrder获取运单数据
getPathlogistics.getPath查询运单轨迹
getPrinterlogistics.getPrinter获取打印员
getQuotalogistics.getQuota获取电子面单余额
updatePrinterlogistics.updatePrinter更新打印员
getContactlogistics.getContact获取面单联系人信息
previewTemplatelogistics.previewTemplate预览面单模板
updateBusinesslogistics.updateBusiness更新商户审核结果
updatePathlogistics.updatePath更新运单轨迹
verifySignaturesoter.verifySignatureSOTER 生物认证秘钥签名验证