wechat open toolkit
1.0.0
Créez facilement une plate-forme de service tiers Node.js WeChat de base.
npm install wechat-open-toolkit const express = require ( 'express' )
const app = express ( )
const WechatOpenToolkit = require ( 'wechat-open-toolkit' )
const {
EVENT_COMPONENT_VERIFY_TICKET , EVENT_AUTHORIZED , EVENT_UPDATE_AUTHORIZED ,
EVENT_UNAUTHORIZED , EVENT_COMPONENT_ACCESS_TOKEN , EVENT_AUTHORIZER_ACCESS_TOKEN ,
EVENT_AUTHORIZER_JSAPI_TICKET
} = WechatOpenToolkit
// 微信第三方平台列表
let list = [
{
componentAppId : '' , // 微信第三方平台 appId
componentAppSecret : '' , // 微信第三方平台 appSecret
token : '' , // 消息校验 Token
encodingAESKey : '' // 消息加解密 key
}
]
let toolkit = new WechatOpenToolkit ( { list } )
// 绑定全部事件
toolkit . on ( EVENT_COMPONENT_VERIFY_TICKET , ret => {
console . log ( ret )
} )
toolkit . on ( EVENT_AUTHORIZED , ret => {
console . log ( ret )
} )
toolkit . on ( EVENT_UPDATE_AUTHORIZED , ret => {
console . log ( ret )
} )
toolkit . on ( EVENT_UNAUTHORIZED , ret => {
console . log ( ret )
} )
toolkit . on ( EVENT_COMPONENT_ACCESS_TOKEN , ret => {
console . log ( ret )
} )
toolkit . on ( EVENT_AUTHORIZER_ACCESS_TOKEN , ret => {
console . log ( ret )
} )
toolkit . on ( EVENT_AUTHORIZER_JSAPI_TICKET , ret => {
console . log ( ret )
} )
toolkit . on ( 'error' , err => {
console . error ( err )
} )
// 通常需要绑定5个中间件
app . use ( '/wechat/events' , toolkit . events ( ) ) // 第三方平台事件接收中间件
list . forEach ( ( { componentAppId } ) => {
let authMiddleware = toolkit . auth ( componentAppId , 'https://domain.com/' ) // 第三方平台网页授权中间件
let msgMiddleware = toolkit . message ( componentAppId ) // 授权方用户消息接收中间件
let autoTestMiddleware = toolkit . autoTest ( componentAppId ) // 第三方平台全网发布测试中间件
app . get ( `/wechat/auth/ ${ componentAppId } ` , authMiddleware )
app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , autoTestMiddleware , ( req , res ) => {
res . end ( 'success' )
console . log ( req . wechat )
} )
app . get ( `/wechat/oauth/ ${ componentAppId } /:authorizerAppId` , ( req , res ) => {
let { authorizerAppId } = req . params
let oauthMiddleware = toolkit . oauth ( componentAppId , authorizerAppId , 'https://domain.com/' ) // 授权方网页授权中间件
oauthMiddleware ( req , res )
} )
} )
app . listen ( 3000 )
console . log ( 'server start at 3000' ) const CoWechatApi = require ( 'co-wechat-api' )
const WechatApi = require ( 'wechat-api' )
let store = { } // 缓存数据
let componentAppId = 'test app id'
let authorizerAppId = 'test app id'
let api = new WechatApi ( '' , '' , callback => {
// 每次调用 api.方法()，都会从 store 对象取 access token
callback ( null , {
accessToken : store [ ` ${ componentAppId } / ${ authorizerAppId } ` ] ,
expireTime : Date . now ( ) + 1000 * 60
}
} )
let coApi = new CoWechatApi ( '' , '' , async ( ) => {
// 每次调用 api.方法()，都会从 store 对象取 access token
return {
accessToken : store [ ` ${ componentAppId } / ${ authorizerAppId } ` ] ,
expireTime : Date . now ( ) + 1000 * 60
}
} )
// 每次授权方 access token 更新时，同步更新缓存数据
toolkit . on ( EVENT_AUTHORIZER_ACCESS_TOKEN , function ( ret ) {
let { AppId , authorizer_appid , authorizer_access_token } = ret
store [ ` ${ AppID } / ${ authorizer_appid } ` ] = authorizer_access_token // 更新
} )
// 该功能需等到 access token 首次更新后，才能调用
api . sendText ( )
await coApi . sendText ( )
///L'exemple de code est uniquement à titre de référence et doit être ajusté en fonction de la situation réelle.
Le compte WeChat Open Platform doit être enregistré sur WeChat Open Platform. Après l'enregistrement, vous obtiendrez le numéro de compte et le mot de passe. (L'adresse e-mail fournie lors de l'inscription n'a jamais été enregistrée pour les comptes publics et les mini-programmes auparavant)
Un compte de plateforme ouverte WeChat peut créer plusieurs plateformes tierces. Après la création, l'appId et l'appSecret de la plateforme tierce seront obtenus. Autrement dit, composantAppId et composantAppSecret utilisés dans le code. (Il existe une limite supérieure pour le nombre de plates-formes tierces, la limite supérieure des types de fournisseurs de services de développement personnalisés est de 5 et la limite supérieure des types de fournisseurs de services de plate-forme est de 5 )
toolkit . on ( EVENT_COMPONENT_VERIFY_TICKET , function ( result ) {
/* {
AppId: "wx304925fbea25bcbe",
CreateTime: "1562424829"
InfoType: "component_verify_ticket",
ComponentVerifyTicket: 'ticket@@@lEHjsBEi_TPDey0IZxw4Zbb7JRYLOtEf9ksvDpSwzkwog3R6xEpdaK0yIee7JOyOXM0V7cp0dpM58GKmb8FSKA'
} */
} )Le serveur WeChat effectuera un push toutes les 10 minutes, ce qui entraînera une indisponibilité du service pendant 1 à 10 minutes après chaque redémarrage du processus (car toutes les autres fonctions dépendent de component_verify_ticket. La solution consiste à stocker les dernières données push, et à chaque fois). est démarré, le même événement est activement déclenché. Les exemples sont les suivants :
// ！在所有侦听事件绑定完成后，再触发事件
// 从数据库（或其他地方）读取上次缓存的数据，通过事件通知给组件
toolkit . emit ( EVENT_COMPONENT_VERIFY_TICKET , {
AppId : "wx52ffab2939ad" ,
CreateTime : "142345003"
InfoType : "component_verify_ticket" ,
ComponentVerifyTicket : 'ticket@@@lEHjsBEi_TPDey0IZxw4Zbb7JRYLOtEf9ksvDpSwzkwog3R6xEpdaK0yIee7JOyOXM0V7cp0dpM58GKmb8FSKA'
} ) toolkit . on ( EVENT_COMPONENT_ACCESS_TOKEN , function ( result ) {
/* {
component_access_token: 'M5CvflZyL5fkV29gU6MhQIoNsvzPEGBjYgmgA7yxnI_l8sblqm0QUULiMHoWY3gXPOnenZs3-42x_EenE1DEAg2F1K3X_fOI44h_eqxrV_7b0K7yc3pEGf_qTZl8HOlyCTSiAHAVML',
expires_in: 7200,
componentAppId: 'componentAppId'
} */
} ) toolkit . on ( EVENT_AUTHORIZER_ACCESS_TOKEN , function ( result ) {
/**
{
AppId: 'wx304925fbea25bcbe',
authorizer_appid: 'wxc736b9251b3c6c41',
authorizer_access_token: 'j7mR_dvcCAmUq5Iw-MuzE4sBT0unN-ukg7LR8EqZEQ1wZ7oyw0rs1Idk40d7uxriOubE3795JiFa3e5jDGdofRpTemXd2HLLV6p_i_Uwy7m2Rp-qv1k1ld-T9iCCDcVeQONdALDFDC',
authorizer_refresh_token: 'refreshtoken@@@6Esz0GgFsth_vRPtqjQd_aIQcCBcJ4iuzQFf3akLwgg',
expires_in: 7200
}
*/
} ) toolkit . on ( EVENT_AUTHORIZER_JSAPI_TICKET , function ( result ) {
/* {
errcode: 0,
errmsg: 'ok',
ticket: 'Zqqmael1_O_ddyFwCE14BtflzySMrtVpp086SHhK3P07xXnhjii2MTmKAGQHBwPOg8GsEtR9HG_dHUngs22ayQ',
expires_in: 7200,
componentAppId: 'wx304925fbea25bcbe',
authorizerAppId: 'wxc736b9251b3c6c41'
} */
} ) toolkit . on ( EVENT_AUTHORIZED , function ( result ) {
/* {
AppId: 'wx304925fbea25bcbe',
CreateTime: '1562428385',
InfoType: 'authorized',
AuthorizerAppid: 'wxc736b9251b3c6c41',
AuthorizationCode: 'queryauthcode@@@SozCwT_ve8WQI6Poum-qdGrrBrnQoX2rApglrUIMF0e308IQY7w_tCfAkndxzUth_YwHDto8DUsIeNrX4atetA',
AuthorizationCodeExpiredTime: '1562431985',
PreAuthCode: 'preauthcode@@@c4Uh5vOCS3wu9Bbx4tJWxplzkn5swwVHQc9xGtF57C1lfk_UeW50INZsh2flrwxh'
} */
} ) toolkit . on ( EVENT_UPDATE_AUTHORIZED , function ( result ) {
/* {
AppId: 'wx304925fbea25bcbe',
CreateTime: '1562426956',
InfoType: 'updateauthorized',
AuthorizerAppid: 'wxc736b9251b3c6c41',
AuthorizationCode: 'queryauthcode@@@SozCwT_ve8WQI6Poum-qdG_rFKaepJCyhL-zx1OkvsxmmJkbZadF78t3U9lh20IaWFqb2DcLne7MGVICr5eRfQ',
AuthorizationCodeExpiredTime: '1562430556',
PreAuthCode: 'preauthcode@@@ivkKNYhiXXsDFLBmH2ccOCg6doXsD_RdQOS7Cxw5GoILrdQktfx_glIzmhWQrMyT'
} */
} ) toolkit . on ( EVENT_UNAUTHORIZED , function ( result ) {
/* {
AppId: 'wx304925fbea25bcbe',
CreateTime: '1562428154',
InfoType: 'unauthorized',
AuthorizerAppid: 'wxc736b9251b3c6c41'
} */
} ) toolkit . on ( 'error' , function ( err ) {
console . error ( err )
} )auth(componentAppId, redirectUrl [, authType]) renvoie le middleware d'autorisation de la plateforme tierce
events() renvoie le middleware de traitement des événements d'autorisation de la plate-forme tierce
message (componentAppId) renvoie le middleware de traitement des messages de la partie autorisant
autoTest(componentAppId) renvoie le middleware pour publier des cas de test sur l'ensemble du réseau
oauth (componentAppId, authoriserAppId, redirectUrl [, scope [, state]]) renvoie le middleware d'autorisation de la page Web de l'autorisateur
getAuthorizerInfo(componentAppId, composantAccessToken, authorAppId) obtient les informations de base du compte de l'autorisateur
clearQuota(componentAppId, composantAccessToken) La plateforme tierce remet à zéro tous les appels d'API
getJsApiConfig(authorizerAppId, authoriserJsApiTicket, url) obtient la configuration du SDK js de l'autorisateur
getOauthAccessToken (componentAppId, composantAccessToken, authorAppId, code) obtient le jeton d'accès à la page Web de l'autorisateur
getUserInfo(authorizerAccessToken, openId) obtient les informations de base de l'utilisateur WeChat autorisateur
send(authorizerAccessToken, openId, type, content) Envoyer un message au service client
getAuthorizerOptionInfo(componentAppId, composantAccessToken, authoriserAppId, optionName) obtient les informations de configuration des options de l'autorisateur
setAuthorizerOption(componentAppId, composantAccessToken, authoriserAppId, optionName, optionValue) définit les informations sur l'option de l'autorisateur
createOpenAccount(authorizerAppId, authoriserAccessToken) crée un compte de plateforme ouverte et lie le compte officiel/mini programme
bindOpenAccount(openAppId, authoriserAppId, authoriserAccessToken) lie le compte/mini-programme officiel au compte de la plateforme ouverte
unbindOpenAccount(openAppId, authoriserAppId, authoriserAccessToken) dissocie le compte/mini-programme officiel du compte de la plateforme ouverte
getOpenAccount(authorizerAppId, authoriserAccessToken) Obtient le compte de plateforme ouverte lié au compte officiel/mini programme
Renvoie le middleware d’autorisation de la plateforme tierce.
Le nom de domaine du lien redirectUrl doit être le même que le nom de domaine du service actuel et le nom de domaine configuré par la plateforme tierce WeChat.
authType spécifie les options facultatives affichées lors de l'autorisation. 1 signifie afficher uniquement les comptes officiels, 2 signifie afficher uniquement les mini-programmes et 3 signifie afficher les comptes officiels et les mini-programmes. La valeur par défaut est 3 . Vous pouvez également transmettre l'APPID de l'autorisateur pour spécifier l'autorisateur.
pageStyle spécifie le style de la page d'autorisation. 1 signifie scanner le code du PC pour autorisation ; 2 signifie que le navigateur WeChat est ouvert. La valeur par défaut est 1 .
const { AUTH_TYPE_BOTH , PAGE_STYLE_PC } = require ( 'wechat-open-toolkit' )
let componentAppId = 'wx52ffab2939ad'
let redirectUrl = 'https://domain.com/authorized'
let authMiddleware = toolkit . auth ( componentAppId , redirectUrl , AUTH_TYPE_BOTH , PAGE_STYLE_PC )
// 浏览器打开该路由即可扫码授权
app . get ( `/wechat/auth/ ${ componentAppId } ` , authMiddleware )Renvoie le middleware de traitement des événements d’autorisation de plate-forme tierce.
app . use ( '/wechat/events' , toolkit . events ( ) )Renvoie le middleware de traitement des messages de la partie autorisant
const componentAppId = 'wx52ffab2939ad'
let msgMiddleware = toolkit . message ( componentAppId ) // 用户消息中间件
app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , ( req , res ) => {
console . log ( req . wechat )
/**
{
ToUserName: 'gh_2a33e5f5a9b0',
FromUserName: 'oVtjJv5NEub-fbE7E6_P2_jCLMXo',
CreateTime: '1508406464',
MsgType: 'text',
Content: 'hello world',
MsgId: '6478556432393017916'
}
*/
} )Lorsque la plate-forme tierce reçoit un message de l'utilisateur autorisé, elle peut utiliser la fonction de réponse passive pour répondre au message.
let componentAppId = 'wx52ffab2939ad' // 第三方平台APPID
let msgMiddleware = toolkit . message ( componentAppId ) // 用户消息中间件
app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , ( req , res ) => {
let { MsgType , Content , MediaId , Label , Title , Description , Url } = req . wechat
switch ( MsgType ) {
case 'text' :
res . text ( Content ) // 被动回复文本消息
break ;
case 'image' :
res . image ( MediaId ) // 被动回复图片消息
break ;
case 'voice' :
res . voice ( MediaId ) // 被动回复语音消息
break ;
case 'video' :
res . video ( MediaId ) // 被动回复视频消息
break ;
case 'location' :
res . text ( Label )
break ;
case 'link' :
res . news ( [ { Title , Description , Url } ] )
}
} )Renvoie le middleware pour publier des cas de test sur l'ensemble du réseau. Ce middleware doit être placé derrière le middleware de messages et avant les autres middlewares.
let componentAppId = 'wx52ffab2939ad'
let msgMiddleware = toolkit . message ( componentAppId ) // 用户消息中间件
let testMiddleware = toolkit . autoTest ( componentAppId ) // 全网发布测试中间件
app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , testMiddleware , ( req , res ) => {
res . end ( 'success' ) // 响应微信服务器
console . log ( req . wechat )
} )Revenez au middleware d'autorisation de la page Web du compte officiel WeChat de l'agent de plate-forme tiers.
scope est la portée de l’autorisation. Les valeurs possibles sont : snsapi_base et snsapi_userinfo. Par défaut : snsapi_base
const { OAUTH_TYPE_USERINFO } = require ( 'wechat-open-toolkit' )
let componentAppId = 'wx304925fbea25bcbe'
let authorizerAppId = 'wxc736b9251b3c6c41'
let redirectUrl = 'https://domain.com/authorized'
let oauthMiddleware = toolkit . oauth ( componentAppId , authorizerAppId , redirectUrl , OAUTH_TYPE_USERINFO )
app . get ( `/wechat/oauth/ ${ componentAppId } / ${ authorizerAppId } ` , oauthMiddleware )Obtenir les informations de base sur le compte de la partie autorisée
let ret = await WechatOpenToolkit . getAuthorizerInfo ( componentAppId , componentAccessToken , authorizerAppId )Obtenez l'objet de configuration js sdk de l'autorisateur
let conf = WechatOpenToolkit . getJsApiConfig ( authorizerAppId , authorizerJsApiTicket , url )
/**
{
appId: '',
timestamp: 158923408,
nonceStr: '292jslk30dk',
signature: '20kjafj20dfhl2j0sjhk2h3f0afjasd2'
}
*/Obtenir le jeton d'accès à la page Web de l'autorisateur
let ret = await WechatOpenToolkit . getOauthAccessToken ( componentAppId , componentAccessToken , authorizerAppId , code )Obtenir les informations de base de l'utilisateur WeChat autorisé
let ret = await WechatOpenToolkit . getUserInfo ( authorizerAccessToken , openId )Envoyer un message au service client
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'text' , { content : '消息内容' } ) // 发送文本消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'image' , { media_id : 'MEDIA_ID' } ) // 发送图片消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'voice' , { media_id : 'MEDIA_ID' } ) // 发送语音消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'video' , {
media_id : 'MEDIA_ID' ,
thumb_media_id : 'MEDIA_ID' ,
title : 'TITLE' ,
description : 'DESCRIPTION'
} ) // 发送视频消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'music' , {
title : 'TITLE' ,
description : 'DESCRIPTION' ,
musicurl : 'MUSIC_URL' ,
hqmusicurl : 'HQ_MUSIC_URL' ,
thumb_media_id : 'MEDIA_ID'
} ) // 发送音乐消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'news' , {
articles : [ {
title : 'TITLE' ,
description : 'DESCRIPTION' ,
url : 'URL' ,
picurl : 'PIC_URL'
} ]
} ) // 发送图文消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'mpnews' , { media_id : 'MEDIA_ID' } ) // 发送图文消息Cette API est utilisée pour obtenir les informations de configuration des options du compte officiel ou du mini-programme de la partie autorisée, telles que : le rapport de localisation géographique, le commutateur de reconnaissance vocale et le commutateur de service multi-client.
let ret = await WechatOpenToolkit . getAuthorizerOptionInfo ( componentAppId , componentAccessToken , authorizerAppId , optionName )Définir les options de l'autorisateur
Cette API est utilisée pour définir les informations d'option du compte officiel ou du mini-programme de la partie autorisée, telles que : le rapport de localisation géographique, le commutateur de reconnaissance vocale et le commutateur de service multi-client.
await WechatOpenToolkit . setAuthorizerOption ( componentAppId , componentAccessToken , authorizerAppId , optionName , optionValue )La plateforme tierce efface toutes les heures d'appel d'API
await WechatOpenToolkit . clearQuota ( componentAppId , componentAccessToken )Créez un compte de plateforme ouverte et liez un compte officiel/un mini-programme
let ret = await WechatOpenToolkit . createOpenAccount ( authorizerAppId , authorizerAccessToken )Liez le compte officiel/mini programme au compte de la plateforme ouverte
await WechatOpenToolkit . bindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )Dissocier le compte officiel/mini programme du compte de la plateforme ouverte
await WechatOpenToolkit . unbindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )Obtenez le compte de la plateforme ouverte lié au compte officiel/mini programme
let ret = await WechatOpenToolkit . getOpenAccount ( authorizerAppId , authorizerAccessToken )
