wechat open toolkit
1.0.0
С легкостью создайте базовую стороннюю сервисную платформу 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 ( )
///Пример кода предназначен только для справки и должен быть скорректирован в соответствии с реальной ситуацией.
Учетную запись открытой платформы WeChat необходимо зарегистрировать на открытой платформе WeChat. После регистрации вы получите номер учетной записи и пароль. (Адрес электронной почты, указанный при регистрации, ранее не был зарегистрирован для паблик-аккаунтов и мини-программ)
Учетная запись открытой платформы WeChat может создавать несколько сторонних платформ. После создания будут получены appId и appSecret сторонней платформы. То есть в коде используются компонентAppId и компонентAppSecret . (Существует верхний предел количества сторонних платформ, верхний предел типов поставщиков услуг индивидуальной разработки — 5 , а верхний предел типов поставщиков услуг платформы — 5 ).
toolkit . on ( EVENT_COMPONENT_VERIFY_TICKET , function ( result ) {
/* {
AppId: "wx304925fbea25bcbe",
CreateTime: "1562424829"
InfoType: "component_verify_ticket",
ComponentVerifyTicket: 'ticket@@@lEHjsBEi_TPDey0IZxw4Zbb7JRYLOtEf9ksvDpSwzkwog3R6xEpdaK0yIee7JOyOXM0V7cp0dpM58GKmb8FSKA'
} */
} )Сервер WeChat будет отправлять каждые 10 минут, что приведет к тому, что служба будет недоступна в течение 1–10 минут после каждого перезапуска процесса (поскольку все остальные функции зависят от компонента_verify_ticket. Решение состоит в том, чтобы сохранять последние данные отправки и каждый раз). запускается, то же самое событие активно запускается. Примеры следующие:
// ！在所有侦听事件绑定完成后，再触发事件
// 从数据库（或其他地方）读取上次缓存的数据，通过事件通知给组件
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(comComponentAppId, redirectUrl [, authType]) возвращает промежуточное программное обеспечение авторизации сторонней платформы.
event() возвращает промежуточное программное обеспечение обработки событий авторизации сторонней платформы.
message(comComponentAppId) возвращает промежуточное программное обеспечение обработки сообщений авторизующей стороны.
autoTest(comComponentAppId) возвращает промежуточное программное обеспечение для публикации тестовых примеров по всей сети.
oauth(comComponentAppId,authorizerAppId,redirectUrl [,scope[,state]]) возвращает промежуточное программное обеспечение авторизации веб-страницы авторизатора.
getAuthorizerInfo(comComponentAppId,ComponentAccessToken,authorizerAppId) получает основную информацию об учетной записи авторизатора.
ClearQuota(comComponentAppId, компонентAccessToken) Сторонняя платформа сбрасывает все вызовы API в ноль.
getJsApiConfig(authorizerAppId,authorizerJsApiTicket, url) получает конфигурацию SDK авторизатора js
getOauthAccessToken(comComponentAppId,ComponentAccessToken,authorizerAppId,code) получает токен доступа к авторизации веб-страницы авторизатора.
getUserInfo(authorizerAccessToken, openId) получает основную информацию об авторизаторе пользователя WeChat.
send(authorizerAccessToken, openId, type, content) Отправить сообщение службы поддержки клиентов
getAuthorizerOptionInfo(comComponentAppId, компонентAccessToken, авторизаторAppId, optionName) получает информацию о настройках опций авторизатора.
setAuthorizerOption(comComponentAppId,ComponentAccessToken,authorizerAppId, optionName, optionValue) устанавливает информацию об опциях авторизатора.
createOpenAccount(authorizerAppId,authorizerAccessToken) создает учетную запись открытой платформы и привязывает официальную учетную запись/мини-программу
bindOpenAccount(openAppId,authorizerAppId,authorizerAccessToken) привязывает официальную учетную запись/мини-программу к учетной записи открытой платформы.
unbindOpenAccount(openAppId,authorizerAppId,authorizerAccessToken) отвязывает официальную учетную запись/мини-программу от учетной записи открытой платформы.
getOpenAccount(authorizerAppId,authorizerAccessToken) Получает учетную запись открытой платформы, привязанную к официальной учетной записи/мини-программе.
Возвращает промежуточное программное обеспечение авторизации сторонней платформы.
Доменное имя ссылки redirectUrl должно совпадать с доменным именем текущей службы и доменным именем, настроенным сторонней платформой WeChat.
authType указывает дополнительные параметры, отображаемые во время авторизации. 1 означает отображение только официальных аккаунтов, 2 означает отображение только мини-программ и 3 означает отображение официальных аккаунтов и мини-программ. По умолчанию — 3 . Вы также можете передать APPID авторизатора, чтобы указать авторизатора.
pageStyle определяет стиль страницы авторизации. 1 означает код сканирования ПК для авторизации; 2 означает, что браузер WeChat открыт. Значение по умолчанию — 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 )Возвращает промежуточное программное обеспечение обработки событий авторизации сторонней платформы.
app . use ( '/wechat/events' , toolkit . events ( ) )Возвращает промежуточное программное обеспечение обработки сообщений авторизующей стороны.
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'
}
*/
} )Когда сторонняя платформа получает сообщение от авторизованного пользователя, она может использовать функцию пассивного ответа, чтобы ответить на сообщение.
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 } ] )
}
} )Возвращает промежуточное программное обеспечение для публикации тестовых случаев по всей сети. Это промежуточное программное обеспечение должно быть размещено после промежуточного программного обеспечения сообщений и перед другим промежуточным программным обеспечением.
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 )
} )Вернитесь к промежуточному программному обеспечению авторизации веб-страницы официального аккаунта стороннего агента платформы WeChat.
область — область авторизации. Возможные значения: snsapi_base и snsapi_userinfo. По умолчанию: 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 )Получите основную информацию об учетной записи уполномоченной стороны.
let ret = await WechatOpenToolkit . getAuthorizerInfo ( componentAppId , componentAccessToken , authorizerAppId )Получите объект конфигурации js sdk авторизатора.
let conf = WechatOpenToolkit . getJsApiConfig ( authorizerAppId , authorizerJsApiTicket , url )
/**
{
appId: '',
timestamp: 158923408,
nonceStr: '292jslk30dk',
signature: '20kjafj20dfhl2j0sjhk2h3f0afjasd2'
}
*/Получите токен авторизации веб-страницы авторизатора.
let ret = await WechatOpenToolkit . getOauthAccessToken ( componentAppId , componentAccessToken , authorizerAppId , code )Получите основную информацию авторизованного пользователя WeChat.
let ret = await WechatOpenToolkit . getUserInfo ( authorizerAccessToken , openId )Отправить сообщение в службу поддержки клиентов
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' } ) // 发送图文消息Этот API используется для получения информации о настройках опций официальной учетной записи или мини-программы уполномоченной стороны, например: отчеты о географическом местоположении, переключатель распознавания голоса и переключатель многопользовательской службы.
let ret = await WechatOpenToolkit . getAuthorizerOptionInfo ( componentAppId , componentAccessToken , authorizerAppId , optionName )Установить параметры авторизации
Этот API используется для установки дополнительной информации официальной учетной записи или мини-программы уполномоченной стороны, такой как отчеты о географическом местоположении, переключатель распознавания голоса и переключатель многопользовательской службы.
await WechatOpenToolkit . setAuthorizerOption ( componentAppId , componentAccessToken , authorizerAppId , optionName , optionValue )Сторонняя платформа очищает все время вызовов API.
await WechatOpenToolkit . clearQuota ( componentAppId , componentAccessToken )Создайте открытую учетную запись платформы и привяжите официальную учетную запись/мини-программу.
let ret = await WechatOpenToolkit . createOpenAccount ( authorizerAppId , authorizerAccessToken )Привязать официальный аккаунт/мини-программу к открытому аккаунту платформы
await WechatOpenToolkit . bindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )Отвязать официальный аккаунт/мини-программу от открытого аккаунта платформы
await WechatOpenToolkit . unbindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )Получите открытую учетную запись платформы, привязанную к официальной учетной записи/мини-программе.
let ret = await WechatOpenToolkit . getOpenAccount ( authorizerAppId , authorizerAccessToken )
