wechat open toolkit
1.0.0
Cree cómodamente una plataforma básica de servicios de terceros Node.js WeChat.
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 ( )
///El código de muestra es solo de referencia y debe ajustarse según la situación real.
La cuenta de WeChat Open Platform debe estar registrada en WeChat Open Platform. Después del registro, obtendrá el número de cuenta y la contraseña. (La dirección de correo electrónico proporcionada durante el registro no se ha registrado antes para cuentas públicas y mini programas)
Una cuenta de plataforma abierta WeChat puede crear múltiples plataformas de terceros. Después de la creación, se obtendrán el appId y el appSecret de la plataforma de terceros. Es decir, componenteAppId y componenteAppSecret utilizados en el código. (Existe un límite superior en la cantidad de plataformas de terceros, el límite superior de tipos de proveedores de servicios de desarrollo personalizados es 5 y el límite superior de tipos de proveedores de servicios de plataforma es 5 )
toolkit . on ( EVENT_COMPONENT_VERIFY_TICKET , function ( result ) {
/* {
AppId: "wx304925fbea25bcbe",
CreateTime: "1562424829"
InfoType: "component_verify_ticket",
ComponentVerifyTicket: 'ticket@@@lEHjsBEi_TPDey0IZxw4Zbb7JRYLOtEf9ksvDpSwzkwog3R6xEpdaK0yIee7JOyOXM0V7cp0dpM58GKmb8FSKA'
} */
} )El servidor WeChat enviará cada 10 minutos, lo que hará que el servicio no esté disponible durante 1 a 10 minutos después de cada reinicio del proceso (porque todas las demás funciones dependen de componente_verify_ticket. La solución es almacenar los datos del último envío y cada vez). se inicia, el mismo evento se activa activamente. Los ejemplos son los siguientes:
// ！在所有侦听事件绑定完成后，再触发事件
// 从数据库（或其他地方）读取上次缓存的数据，通过事件通知给组件
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, redirigirUrl [, authType]) devuelve el middleware de autorización de plataforma de terceros
events() devuelve el middleware de procesamiento de eventos de autorización de plataforma de terceros
message(componentAppId) devuelve el middleware de procesamiento de mensajes de la parte autorizadora
autoTest(componentAppId) devuelve el middleware para publicar casos de prueba en toda la red
oauth(componentAppId, AuthorizerAppId, refundirUrl [, alcance [, estado]]) devuelve el middleware de autorización de la página web del autorizador
getAuthorizerInfo(componentAppId, componenteAccessToken, AuthorizerAppId) obtiene la información básica de la cuenta del autorizador
clearQuota(componentAppId, componenteAccessToken) La plataforma de terceros borra todas las llamadas API a cero
getJsApiConfig(authorizerAppId, AuthorizerJsApiTicket, url) obtiene la configuración del autorizador js SDK
getOauthAccessToken(componentAppId, componenteAccessToken, AuthorizerAppId, código) obtiene el token de acceso de autorización a la página web del autorizador
getUserInfo(authorizerAccessToken, openId) obtiene la información básica del usuario autorizado de WeChat
enviar(authorizerAccessToken, openId, tipo, contenido) Enviar mensaje de servicio al cliente
getAuthorizerOptionInfo(componentAppId, componenteAccessToken, AuthorizerAppId, optionName) obtiene la información de configuración de opciones del autorizador
setAuthorizerOption(componentAppId, componenteAccessToken, AuthorizerAppId, optionName, optionValue) establece la información de la opción del autorizador
createOpenAccount(authorizerAppId, AuthorizerAccessToken) crea una cuenta de plataforma abierta y vincula la cuenta oficial/miniprograma
bindOpenAccount(openAppId, AuthorizerAppId, AuthorizerAccessToken) vincula la cuenta oficial/miniprograma a la cuenta de plataforma abierta
unbindOpenAccount(openAppId, AuthorizerAppId, AuthorizerAccessToken) desvincula la cuenta oficial/miniprograma de la cuenta de plataforma abierta
getOpenAccount(authorizerAppId, AuthorizerAccessToken) Obtiene la cuenta de plataforma abierta vinculada a la cuenta oficial/miniprograma.
Devuelve el middleware de autorización de plataforma de terceros.
El nombre de dominio del enlace de redirecciónUrl debe ser el mismo que el nombre de dominio del servicio actual y el nombre de dominio configurado por la plataforma de terceros WeChat.
authType especifica las opciones opcionales que se muestran durante la autorización. 1 significa mostrar solo cuentas oficiales, 2 significa mostrar solo miniprogramas y 3 significa mostrar cuentas oficiales y miniprogramas. El valor predeterminado es 3 . También puede pasar el APPID del autorizador para especificar el autorizador.
pageStyle especifica el estilo de la página de autorización. 1 significa código de escaneo de PC para autorización; 2 significa que el navegador WeChat está abierto. El valor predeterminado es 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 )Devuelve el middleware de procesamiento de eventos de autorización de plataforma de terceros.
app . use ( '/wechat/events' , toolkit . events ( ) )Devuelve el middleware de procesamiento de mensajes de la parte autorizante.
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'
}
*/
} )Cuando la plataforma de terceros recibe un mensaje del usuario autorizado, puede utilizar la función de respuesta pasiva para responder al mensaje.
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 } ] )
}
} )Devuelve el middleware para publicar casos de prueba en toda la red. Este middleware debe colocarse detrás del middleware de mensajes y antes que otro middleware.
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 )
} )Regrese al middleware de autorización de la página web de la cuenta oficial de WeChat del agente de plataforma de terceros.
El alcance es el alcance de la autorización. Los valores posibles son: snsapi_base y snsapi_userinfo. Valor predeterminado: 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 )Obtener la información básica de la cuenta de la parte autorizada.
let ret = await WechatOpenToolkit . getAuthorizerInfo ( componentAppId , componentAccessToken , authorizerAppId )Obtenga el objeto de configuración js SDK del autorizador
let conf = WechatOpenToolkit . getJsApiConfig ( authorizerAppId , authorizerJsApiTicket , url )
/**
{
appId: '',
timestamp: 158923408,
nonceStr: '292jslk30dk',
signature: '20kjafj20dfhl2j0sjhk2h3f0afjasd2'
}
*/Obtenga el token de acceso de autorización a la página web del autorizador
let ret = await WechatOpenToolkit . getOauthAccessToken ( componentAppId , componentAccessToken , authorizerAppId , code )Obtener la información básica del usuario autorizado de WeChat
let ret = await WechatOpenToolkit . getUserInfo ( authorizerAccessToken , openId )Enviar mensaje de atención al cliente
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' } ) // 发送图文消息Esta API se utiliza para obtener la información de configuración de opciones de la cuenta oficial o miniprograma de la parte autorizada, como: informes de ubicación geográfica, cambio de reconocimiento de voz y cambio de servicio para múltiples clientes.
let ret = await WechatOpenToolkit . getAuthorizerOptionInfo ( componentAppId , componentAccessToken , authorizerAppId , optionName )Establecer opciones de autorizador
Esta API se utiliza para configurar la información de opción de la cuenta oficial o mini programa de la parte autorizada, como: informes de ubicación geográfica, cambio de reconocimiento de voz y cambio de servicio para múltiples clientes.
await WechatOpenToolkit . setAuthorizerOption ( componentAppId , componentAccessToken , authorizerAppId , optionName , optionValue )La plataforma de terceros borra todos los tiempos de llamada API
await WechatOpenToolkit . clearQuota ( componentAppId , componentAccessToken )Cree una cuenta de plataforma abierta y vincule una cuenta oficial/miniprograma
let ret = await WechatOpenToolkit . createOpenAccount ( authorizerAppId , authorizerAccessToken )Vincular la cuenta oficial/miniprograma a la cuenta de plataforma abierta
await WechatOpenToolkit . bindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )Desvincular la cuenta oficial/miniprograma de la cuenta de plataforma abierta
await WechatOpenToolkit . unbindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )Obtenga la cuenta de plataforma abierta vinculada a la cuenta oficial/mini programa
let ret = await WechatOpenToolkit . getOpenAccount ( authorizerAppId , authorizerAccessToken )
