wechat jssdk herunterladen - wechat jssdk Quellcode herunterladen

wechat-jssdk

WeChat JSSDK-Integration mit NodeJS und Web WeChat JS-SDK-Integration mit NodeJS und Web.

Englisch |. Versionshinweise

Hauptfunktionen

?Server
?Browserseite
?OAuth-Webautorisierung
?WeChat-Gutscheine
?WeChat Pay
?WeChat-Applet
?Stores nutzen
?Vollständige Demo

Wie zu verwenden

npm install wechat-jssdk --save
# 或者
yarn add wechat-jssdk

 const { Wechat } = require ( 'wechat-jssdk' ) ;
const wx = new Wechat ( wechatConfig ) ;

Wechat-Konfigurationselemente

wechatConfig hat das folgende Format:

 {
  //第一个为设置网页授权回调地址
  wechatRedirectUrl : "http://yourdomain.com/wechat/oauth-callback" , 
  wechatToken : "xxx" , //第一次在微信控制台保存开发者配置信息时使用
  appId : "xxx" ,
  appSecret : "xxx" ,
  card : true , //开启卡券支持，默认关闭
  payment : true , //开启支付支持，默认关闭
  merchantId : '' , //商户ID
  paymentSandBox : true , //沙箱模式，验收用例
  paymentKey : '' , //必传，验签密钥，TIP:获取沙箱密钥也需要真实的密钥，所以即使在沙箱模式下，真实验签密钥也需要传入。
  //pfx 证书
  paymentCertificatePfx : fs . readFileSync ( path . join ( process . cwd ( ) , 'cert/apiclient_cert.p12' ) ) ,
  //默认微信支付通知地址
  paymentNotifyUrl : `http://your.domain.com/api/wechat/payment/` ,
  //小程序配置
  "miniProgram" : {
    "appId" : "mp_appid" ,
    "appSecret" : "mp_app_secret" ,
  }
}

Andere unterstützte Einstellungen haben Standardwerte, die im Wesentlichen die Adressen der WeChat-API sind und sich nicht ändern. Sie können ./lib/config.js überprüfen.

Richten Sie eine WeChat-Umgebung ein

1. Gehen Sie zur öffentlichen WeChat-Plattform

Laden Sie eine Datei wie MP_verify_XHZon7GAGRdcAFxx.txt herunter und legen Sie sie im Stammverzeichnis der Website ab, z. B. http://yourdomain.com/MP_verify_XHZon7GAGRdcAFxx.txt . WeChat überprüft den Link.

2. Stellen Sie dann in Ihrer Express/Koa-App eine Schnittstelle für den Browser bereit, um Verifizierungsinformationen zu erhalten, @siehe Demo

 //express app:
router . get ( '/get-signature' , ( req , res ) => {
  wx . jssdk . getSignature ( req . query . url ) . then ( signatureData => {
    res . json ( signatureData ) ;
  } ) ;
} ) ;
//koa2/koa-router app:
router . get ( '/get-signature' , async ctx => {
  ctx . body = await wx . jssdk . getSignature ( ctx . request . query . url ) ;
} ) ;

3. Nachdem Sie die Signatur erhalten haben, fahren Sie mit dem nächsten Schritt zur Verwendung des Browsers fort.

Browserseite

 const WechatJSSDK = require ( 'wechat-jssdk/dist/client.umd' ) ;
//ES6 import
import WechatJSSDK from 'wechat-jssdk/dist/client.umd' ;

//没有打包的话直接script扔到html，然后从`window`获取, e.g:
const wechatObj = new window . WechatJSSDK ( config )

config sollte sein:

 const config = {
  //前4个是微信验证签名必须的参数，第2-4个参数为类似上面 '/get-signature' 从node端获取的结果
  'appId' : 'xxx' ,
  'nonceStr' : 'xxx' ,
  'signature' : 'xxx' ,
  'timestamp' : 'xxx' ,
  //下面为可选参数
  'debug' : true , //开启 debug 模式
  'jsApiList' : [ ] , //设置所有想要使用的微信jsapi列表, 默认值为 ['updateAppMessageShareData','updateTimelineShareData','onMenuShareTimeline', 'onMenuShareAppMessage']，分享到朋友圈及聊天记录
  'customUrl' : '' //自定义微信js链接
}
const wechatObj = new WechatJSSDK ( config ) ;
wechatObj . initialize ( )
  . then ( w => {
    //set up your share info, "w" is the same instance as "wechatObj"
  } )
  . catch ( err => {
    console . error ( err ) ;
  } ) ;

Nach erfolgreicher Überprüfung der Signatur können Sie Ihre Freigabeinhalte anpassen:

Standardmäßig registriert SDK nur updateAppMessageShareData , updateTimelineShareData , onMenuShareTimeline(wx即将废弃) und onMenuShareAppMessage(wx即将废弃)

 //自定义分享到聊天窗口
//内部调用 `wechatObj.callWechatApi('updateAppMessageShareData', {...})`， 语法糖而已
wechatObj . updateAppMessageShareData ( {
  type : 'link' ,
  title : 'title' ,
  link : location . href ,
  imgUrl : '/logo.png' ,
  desc : 'description' ,
  success : function ( ) { } ,
  fail : function ( ) { } ,
  complete : function ( ) { } ,
  cancel : function ( ) { }
} ) ;
//自定义分享到朋友圈
//语法糖
wechatObj . updateTimelineShareData ( {
  type : 'link' ,
  title : 'title' ,
  link : location . href ,
  imgUrl : '/logo.png'
} ) ;

Um das ursprüngliche WeChat-Objekt wx zu erhalten, können Sie es über wechatObj.getOriginalWx() abrufen.
Wenn die erste Überprüfung fehlschlägt, können Sie die Signaturinformationen im error aktualisieren und die Überprüfungsanforderung erneut senden:
wechatObj.signSignature(newSignatureConfig); , newSignatureConfig muss nur Folgendes enthalten:

 {
  'nonceStr': 'xxx',
  'signature': 'xxx',
  'timestamp': 'xxx',
}

Rufen Sie andere WeChat-Schnittstellen auf:
wechatObj.callWechatApi(apiName, apiConfig)
apiName und apiConfig finden Sie in der offiziellen Dokumentation zur WeChat-Schnittstelle.

OAuth

Die standardmäßig generierten WeChat-Autorisierungs-URLs sind wx.oauth.snsUserInfoUrl und wx.oauth.snsUserBaseUrl , und die standardmäßige Rückruf-URL ist die in wechatConfig konfigurierte wechatRedirectUrl . Sie können den Rückruf auch anpassen, indem Sie wx.oauth. generateOAuthUrl(customUrl, scope, state) aufrufen wx.oauth. generateOAuthUrl(customUrl, scope, state) Adresse

 //callback url handler
//如"wechatRedirectUrl"配置为 "http://127.0.0.1/wechat/oauth-callback", 你的路由需要为：
router . get ( '/wechat/oauth-callback' , function ( req , res ) {
  //得到code，获取用户信息
  wx . oauth . getUserInfo ( req . query . code )
          . then ( function ( userProfile ) {
            console . log ( userProfile )
            res . render ( "demo" , {
              wechatInfo : userProfile
            } ) ;
          } ) ;
} ) ;

TIPP: Stellen Sie sicher, dass der oben genannte Domänenname der Umleitungsadresse in den Einstellungen für autorisierte Rückrufadressen in WeChat festgelegt wurde.

WeChat-Gutscheine

Legen Sie card: true in wechatConfig fest, um serverseitige Unterstützung für Karten- und Couponfunktionen zu unterstützen, siehe Demo.
Informationen zum Anzeigen der Karten- und Coupon-APIs finden Sie unter Karten-APIs

WeChat-Bezahlung

Legen Sie payment: true in wechatConfig fest, um die serverseitige Unterstützung für die WeChat-Zahlungsfunktion zu unterstützen. Weitere erforderliche Konfigurationen für die Zahlung müssen ebenfalls festgelegt werden.
Referenzdemo.
Informationen zum Anzeigen der Zahlungs-APIs finden Sie unter Zahlungs-APIs

Miniprogramm

Nutzen Sie die serverseitige Unterstützung des Miniprogramms (siehe Schnittstelle) und legen Sie appId und appSecret des Miniprogramms in der Konfiguration fest:

 const { Wechat , MiniProgram } = require ( 'wechat-jssdk' ) ;
const wechatConfig = {
  "appId" : "appid" ,
  "appSecret" : "app_secret" ,
  //...other configs
  //...
  //小程序配置
  "miniProgram" : {
    "appId" : "mp_appid" ,
    "appSecret" : "mp_app_secret" ,
  }
} ;
const wx = new Wechat ( wechatConfig ) ;
//调用小程序接口
wx . miniProgram . getSession ( 'code' ) ;

//手动实例化 MiniProgram
const miniProgram = new MiniProgram ( {
  miniProgram : {
    "appId" : "mp_appid" ,
    "appSecret" : "mp_app_secret" ,
  }
} )

Nutzung von Stores

Store wird verwendet, um die Speichertoken-Persistenz (z. B. Dateien, Datenbanken usw.) anzupassen und Ihren eigenen Store zu implementieren. Bitte sehen Sie sich die API an.
Kommt mit Store: FileStore , MongoStore , der Standardwert ist FileStore , gespeichert in der Datei wechat-info.json .

APIs

Sehen Sie sich das API-Wiki an

Demo

Nach v3.1.0 fügt die Demoseite Anwendungsfalltests für Gutscheine und Zahlungen hinzu. Kopieren Sie demo/wechat-config-sample.js nach demo/wechat-config.js .
Ändern Sie dann appId , appSecret und andere Konfigurationen wie Zahlungskonfigurationen, wenn Sie die Zahlungsfunktion verwenden müssen.

Legen Sie Ihre eigene appId und appSecret in ./demo/index.js fest, dann npm start oder npm run dev und verwenden Sie die WeChat-Entwicklertools zum Testen.