Page d'accueil>Lié à la programmation>Code Source AI
Télécharger

nid-wechat

Compte officiel WeChat, développement du programme WeChat, mini-jeux WeChat, paiement WeChat et entreprise WeChat et autre encapsulation de modules nestjs API côté serveur. Il peut également être utilisé directement comme classe d’outils.

nest-wechat est un package destiné aux entreprises à usage personnel. Si l'API que vous devez utiliser n'est pas encore disponible, vous pouvez me soumettre des problèmes et je le rattraperai dès que possible.

Documentation chinoise

démarrage rapide

Installer

 npm i --save nid-wechat

présentation du module nestjs

  • enregistrement de la méthode d'enregistrement

 importer { Module } depuis '@nestjs/common'; importer { WeChatModule } depuis 'nest-wechat';@Module({
importations : [WeChatModule.register({appId : 'votre identifiant d'application', secret : 'votre secret'})],})export class AppModule {}

  • Enregistrement de la configuration forRoot

 importer { CACHE_MANAGER, Module } depuis '@nestjs/common'; importer { ConfigModule, ConfigService } depuis '@nestjs/config'; importer { Cache } depuis 'cache-manager'; importer { RedisCache, WeChatModule } depuis 'nest-wechat ';@Module({
importations : [ConfigModule.forRoot({ envFilePath : '.env.test.local',}),WeChatModule.forRootAsync({ importations : [ConfigModule], injecter : [ConfigService, CACHE_MANAGER], useFactory : (configService : ConfigService, cache : Cache) => ({appId : configService.get('WX_APPID'), secret : configService.get('WX_SECRET'), jeton : configService.get('WX_TOKEN'), encodingAESKey : configService.get('WX_AESKEY'), cacheAdapter : nouveau RedisCache(cache), débogage : vrai, }),}),
]})classe d'exportation AppModule {}

Présentation des outils

 importer { WeChatService } depuis 'nest-wechat'; const service = new WeChatService ({ appId : 'votre identifiant d'application', secret : 'votre secret'});

interface globale

ICache

 /** * Interface de cache, veuillez implémenter cette interface si vous avez besoin de personnaliser le cache * * Interface de cache, veuillez implémenter cette interface si vous en avez besoin.
get<T> (clé : chaîne) : Promise<T> ;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
set (clé : chaîne, valeur : any) : void ;
supprimer (clé : chaîne) : booléen ;
fermer (): vide;}

Propriétés et méthodes WeChatService

configuration : WeChatModuleOptions

Configurez les propriétés de lecture et d'écriture, tapez : WeChatModuleOptions

cacheAdaptateur : ICache

Attributs de lecture et d'écriture de l'adaptateur de cache, tapez : ICache, la valeur par défaut est un cache implémenté par Map

API de compte public WeChat

Autorisation Web

getAccessTokenByCode

 public async getAccessTokenByCode (code : chaîne, _appId ? : chaîne, _secret ? : chaîne) : Promise<UserAccessTokenResult> ;

Retourner correctement

 { "access_token": "ACCESS_TOKEN", "expires_in": 7200, "refresh_token": "REFRESH_TOKEN", "openid": "OPENID", "scope": "SCOPE" }

retour d'erreur

 {"errcode": 40029,"errmsg": "code invalide"}

Documentation de référence

getUserInfo

Le compte officiel extrait les informations des utilisateurs

 public async getUserInfo (accessToken : chaîne, openid : chaîne, lang : 'zh_CN' | 'zh_TW' | 'en' = 'zh_CN') : Promise<UserInfoResult> ;

Retourner correctement

 {
"openid": "OPENID", "nickname": NICKNAME,
"sexe": 1, "province": "PROVINCE", "ville": "VILLE", "pays": "PAYS", "headimgurl": https://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/46", "privilège":[ "PRIVILEGE1" "PRIVILEGE2" ], "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"}

retour d'erreur

 { "errcode": 40003, "errmsg": "openid invalide"}

Obtenir un jeton d'accès

getAccountAccessToken

 public async getAccountAccessToken (_appId ? : chaîne, _secret ? : chaîne) : Promise<AccountAccessTokenResult> ;

Retourner correctement

 { "access_token": "52_s0Mcl3E3DBKs12rthjxG8_DOvsIC4puV9A34WQR6Bhb_30TW9W9BjhUxDRkyph-hY9Ab2QS03Q8w ZBe5UkA1k0q0hc17eUDZ7vAWItl4iahnhq_57dCoKc1dQ3AfiHUKGCCMJ2NcQ0BmbBRIKBEgAAAPGJ", "expires_in": 7200}

retour d'erreur

 { "errcode": 40013, "errmsg": "appid invalide"}

Documentation de référence

Obtenir les informations d'identification d'appel de l'interface de version stable

getStableAccessToken

 public async getStableAccessToken (_appId ? : string, _secret ? : string, force = false) : Promise<AccountAccessTokenResult> ;

Documentation de référence

Obtenez jsapi_ticket

getJSApiTicket

 public async getJSApiTicket (_appId ? : chaîne, _secret ? : chaîne) : Promise<TicketResult> ;

Renvoyer les données

 { "errcode": 0, "errmsg": "ok", "ticket": "bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA", "expires_in": 7200}

Documentation de référence

JS-SDK utilise la signature d'autorisation

jssdkSignature

 public async jssdkSignature (url : chaîne) : Promise<SignatureResult> ; public async jssdkSignature (url : chaîne, appId : chaîne, secret : chaîne) : Promise<SignatureResult> ;

Documentation de référence

Envoyer un modèle de message

envoyerModèleMessage

 public async sendTemplateMessage (message : TemplateMessage, appId ? : string, secret ? : string) : Promise<DefaultRequestResult & { msgid : string }> ;

Documentation de référence

Générer un code QR avec des paramètres

créer un QRCode

 public async createQRCode (données : AccountCreateQRCode, appId ? : string, secret ? : string) : Promise<AccountCreateQRCodeResult> ;

Documentation de référence

Échangez vos billets contre des codes QR

afficherQRCode

 public showQRCode (ticket : chaîne) : Promis<Buffer> ;

Documentation de référence

Remplissez la configuration du serveur

checkSignatureExpress

 WeChatService.checkSignatureExpress (req : demande, res : réponse) ;

Usage:

 @Get('push')async pushTest (@Req() req : Requête, @Res() res : Réponse) {
this.service.checkSignatureExpress(req, res);}

Documentation de référence

Recevoir un push d'événement

messagePushExpressHandler

 // Mode crypté WeChatService.messagePushExpressHandler (req : Request, res ? : Response, resText ? : string) ; // Mode texte brut WeChatService.plainMessagePushExpressHandler (req : Request, res ? : Response, resText ? : string) ;

Usage:

 @Post('push')async officialPushTest (@Req() req : Requête, @Res() res : Réponse) {
const décrypter = attendre this.service.messagePushExpressHandler(req, res);}

Documentation de référence

Applet WeChat

Obtenir les identifiants d'appel de l'interface

 public getAccessToken (appId ? : chaîne, secret ? : chaîne) : Promise<AccessTokenResult> ;
 const service = new WeChatService({ appId : 'votre identifiant d'application', secret : 'votre secret'}); const res = wait service.mp.getAccessToken();console.log(res.data.access_token);

Interroger les informations débarrassées

 public async getRid (rid : string, accessToken : string) : Promise<RidInfo> ;

Obtenir l'utilisateur du plugin openpid

 public async getPluginOpenPId (code : chaîne, accessToken : chaîne) : Promise<DefaultRequestResult & { openpid : chaîne }> ;

Connectez-vous à code2Session

 code2Session asynchrone public (code : chaîne, appId ? : chaîne, secret ? : chaîne) : Promise<SessionResult> ;

Renvoyer les données

 { "openid": "openid", "session_key": "key", "unionid": "unionid", "errcode": 0, "errmsg": "ok",
}

Documentation de référence

Obtenir un numéro de portable

 public async getPhoneNumber (code : chaîne, accessToken : chaîne) ;

Documentation de référence

Obtenez le code de l'applet

 public async getQRCode (params : QRCode, accessToken : string) : Promise<DefaultRequestResult & { contentType : string, buffer : Buffer }> ;

Obtenez des codes de mini-programmes illimités

 public getUnlimitedQRCode (params : GetUnlimitedQRCode, accessToken : string) : Promise<DefaultRequestResult & { buffer: Buffer }> ;

Récupérez le QR code du mini programme

 public async createQRCode (params : CreateQRCode, accessToken : string) : Promise<DefaultRequestResult & { contentType : string, buffer : Buffer }> ;

Code du schéma de requête

 public async queryScheme (scheme : string, accessToken : string) : Promise<DefaultRequestResult & { Scheme_info : SchemeInfo, Scheme_quota : SchemeQuota }> ;

Obtenir le code du schéma

 public generateScheme (params : GenerateScheme, accessToken : string) : Promise<DefaultRequestResult & { openlink : string > ;

Obtenez le schéma d'applet NFC

 public generateNFCScheme (params : GenerateNFCScheme, accessToken : string) : Promise<DefaultRequestResult & { openlink: string }> ;

Obtenir le lien URL

 public generateUrlLink (params : GenerateUrlLink, accessToken : string) : Promise<DefaultRequestResult & { url_link : string }> ;

Lien URL de requête

 public queryUrlLink (urlLink : chaîne, accessToken : chaîne) : Promise<UrlLinkResult> ;

ObtenirShortLink

 public generateShortLink (params : GenerateShortLink, accessToken : string) : Promise<DefaultRequestResult & { link: string }> ;

Envoyer des messages unifiés

 public sendUniformMessage (paramètres : SendUniformMessage, accessToken : string) : Promise<DefaultRequestResult> ;

Créer Activity_id

 public createActivityId (params : CreateActivityId, accessToken : string) : Promise<ActivityIdResult> ;

Modifier le fil d'actualité

 public setUpdatableMsg (params : UpdatableMsg, accessToken : string) : Promise<DefaultRequestResult> ;

Supprimer le modèle

 public deleteMessageTemplate (priTmplId : chaîne, accessToken : chaîne) : Promise<DefaultRequestResult> ;

Obtenir la catégorie

 public getCategory (accessToken : string) : Promise<DefaultRequestResult & { data : {id : number, name : string}[] }>;

Obtenir la liste des mots clés

 public getPubTemplateKeyWordsById (tid : numéro, accessToken : chaîne) : Promise<PubTemplateKeyWords> ;

Obtenez des modèles publics dans la catégorie à laquelle ils appartiennent

 public getPubTemplateTitleList (paramètres : PubTemplateTitleList, accessToken : string) : Promise<PubTemplateTitleListResult> ;

Obtenir une liste de modèles personnels

 public getMessageTemplateList (accessToken : string) : Promise<MessageTemplateListResult> ;

Envoyer un message d'abonnement

 public sendMessage (paramètres : SendMessage, accessToken : string) : Promise<DefaultRequestResult> ;

Ajouter un modèle

 public addMessageTemplate (params : MessageTemplate, accessToken : string) : Promise<DefaultRequestResult & { priTmplId : string }> ;

application mobile

Importation de modules

 importer { Module } depuis '@nestjs/common'; importer { WeChatMobileModule } depuis 'nest-wechat';@Module({
importations : [WeChatMobileModule.register()],})classe d'exportation AppModule {}

Présentation des outils

 importer { MobileService } depuis 'nest-wechat'; const service = new MobileService ();

Obtenez access_token via le code

 public getAccessToken (code : chaîne, appId : chaîne, secret : chaîne) : Promise<AxiosResponse<MobileAppAccessTokenResult, any>> ;

Actualiser ou renouveler access_token

 public rafraîchirAccessToken (appId : chaîne, rafraîchirToken : chaîne) : Promise<AxiosResponse<MobileAppAccessTokenResult, any>> ;

Vérifier access_token

 public checkAccessToken (openId : string, accessToken : string) : Promise<AxiosResponse<DefaultRequestResult, any>> ;

Paiement WeChat

Mini-programme

Commande JSAPI

 pay.jsapi (ordre : TransactionOrder, SerialNo : chaîne, privateKey : Buffer | chaîne) : Promise<{prepay_id : chaîne}> ;

Ordre de requête du numéro de commande du commerçant

 pay.getTransactionById (id : chaîne, mchId : chaîne, numéro de série : chaîne, privateKey : Buffer | chaîne) : Promise<Trade> ;

Ordre de requête du numéro d'ordre de paiement WeChat

 pay.getTransactionByOutTradeNo (outTradeNo : chaîne, mchId : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) : Promise<Trade> ;

Fermer la commande

 pay.close (outTradeNo : chaîne, mchId : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne );

Veuillez retirer la candidature

 pay.refund (remboursement : RequireOnlyOne<RefundParameters, 'transaction_id' | 'out_trade_no'>, mchId : string, serialNo : string, privateKey : Buffer | string) : Promise<RefundResult> ;

Interroger un seul remboursement

 pay.getRefund (outRefundNo : string, mchId : string, serialNo : string, privateKey : Buffer | string) : Promise<RefundResult> ;

Construire un petit programme pour appeler les paramètres de paiement

 pay.buildMiniProgramPayment (appId : chaîne, prepayId : chaîne, privateKey : Buffer | chaîne) : MiniProgramPaymentParameters ;

Gestionnaire de notifications de paiement

 pay.paidCallback (publicKey : Buffer | string, apiKey : string, req : Request, res : Response) : Promise<Trade> ;

Gestionnaire de notification de remboursement

 pay.refundedCallback (certs : Map<string, string>, apiKey : string, req : Request, res : Response) : Promise<RefundNotifyResult> ;

Facture électronique

Configurer les options de développement

 pay.fapiaoDevConfig (données : DevelopmentConfigRequest, mchId : chaîne, numéro de série : chaîne, privateKey : Buffer | chaîne );

Interroger les options de développement configurées par le commerçant

 pay.getFapiaoDevConfig (mchId : chaîne, numéro de série : chaîne, privateKey : Buffer | chaîne) ;

Créer un modèle de facture électronique, de carte et de coupon

 pay.createCardTemplate (données : CreateCardTemplateRequest, mchId : chaîne, SerialNo : chaîne, privateKey : Buffer | chaîne );

Notification de facture WeChat

 pay.fapiaoCallback (certs : Map<string, string>, apiKey : string, req : Request, res : Response) : Promise<FapiaoNotifyResult> ;

Récupère l'en-tête rempli par l'utilisateur

 pay.getUserTitle (paramètres : GetUserTitleParams, mchId : chaîne, numéro de série : chaîne, privateKey : Buffer | chaîne );

Émettre des factures électroniques

 pay.issueFapiao (données : IssueFapiaoRequest, mchId : chaîne, numéro de série : chaîne, privateKey : Buffer | chaîne );

Demander une facture électronique

 pay.getIssueFapiao (fapiaoApplyId : chaîne, fapiaoId : chaîne, mchId : chaîne, SerialNo : chaîne, privateKey : Buffer | chaîne) ;

facture électronique rouge

 pay.reverseFapiao (fapiaoApplyId : chaîne, données : ReverseFapiaoRequest, mchId : chaîne, SerialNo : chaîne, privateKey : Buffer | chaîne) ;

Cryptage et décryptage des informations sensibles

cryptage

 pay.rsaEncryptOAEP (texte : chaîne, publicKey : Buffer | chaîne) ;

Décrypter

 pay.rsaDecryptOAEP (cipherText : chaîne, privateKey : Buffer | chaîne) ;

enveloppe rouge en espèces

Aucun marchand test n'est disponible et le test n'a pas réussi. Veuillez tester par vous-même. Si vous avez des questions, veuillez soumettre un problème.

Le test peut exécuter des tests unitaires tout seul (nécessité de modifier la configuration)

 npm exécuter le test lib/wepay.hb.spec.ts

distribuer des enveloppes rouges

 pay.sendRedPack (redPack : RedPackData, appId : string, mchId : string, apiKey : string, publicKey : Buffer | string, privateKey : Buffer | string, group = false) : Promise<AxiosResponse<string, any>> ;

Distribuer des enveloppes rouges de fission

 pay.sendGroupRedPack (redPack : GroupRedPackData, appId : chaîne, mchId : chaîne, apiKey : chaîne, publicKey : Buffer | chaîne, privateKey : Buffer | chaîne) : Promise<AxiosResponse<string, any>> ;

Interroger les enregistrements d'enveloppe rouge

 pay.getHbInfo (billNO : chaîne, appId : chaîne, mchId : chaîne, apiKey : chaîne, publicKey : Buffer | chaîne, privateKey : Buffer | chaîne) : Promise<AxiosResponse<string, any>> ;

Fournisseur de services de paiement WeChat

Commande JSAPI du fournisseur de services

Documentation de référence

 jsapiOfPartner (ordre : TransactionOrderOfPartner, SerialNo : chaîne, privateKey : Buffer | chaîne) ;

Le fournisseur de services JSAPI appelle le paiement

Documentation de référence

Créer une interface pour appeler les paramètres de paiement WeChat

 buildJSAPIParameters (appId : chaîne, prepayId : chaîne, privateKey : Buffer | chaîne) : MiniProgramPaymentParameters ;

Notification de paiement du prestataire de services

Documentation de référence

 paidCallbackOfPartner (certs : Map<string, string>, apiKey : string, req : Request, res : Response) : Promise<TradeOfPartner> ;

Le fournisseur de services clôture la commande

Documentation de référence

 closeOfPartner (outTradeNo : chaîne, spMchId : chaîne, subMchId : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) ;

Ordre de requête du numéro d'ordre de paiement WeChat du fournisseur de services

Documentation de référence

 getTransactionByIdOfPartner (id : chaîne, spMchId : chaîne, subMchid : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) ;

Commande de requête de numéro de commande du commerçant du fournisseur de services

Documentation de référence

 getTransactionByOutTradeNoOfPartner (outTradeNo : chaîne, spMchId : chaîne, subMchid : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) ;

Demande de remboursement du prestataire

Documentation de référence

 returnOfPartner (remboursement : RequireOnlyOne<RefundParametersOfPartner, 'transaction_id' | 'out_trade_no'>, spMchId : string, serialNo : string, privateKey : Buffer | string) ;

Le fournisseur de services demande un remboursement unique

Documentation de référence

 getRefundOfPartner (outRefundNo : chaîne, spMchId : chaîne, subMchId : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) ;

Notification du résultat du remboursement du fournisseur de services

Documentation de référence

 rembourséCallbackOfPartner (certificats : Map<string, string>, apiKey : string, req : Request, res : Response) : Promise<RefundNotifyResultOfPartner> ;

Facture électronique du prestataire

Le fournisseur de services crée un modèle de facture, de carte et de coupon électronique

Documentation de référence

 createCardTemplateOfPartner (données : CreateCardTemplateRequestOfPartner, spMchId : chaîne, SerialNo : chaîne, privateKey : Buffer | chaîne) ;
Options de développement de la configuration du fournisseur de services

Documentation de référence

 fapiaoDevConfigOfPartner (données : DevelopmentConfigRequestOfPartner, spMchId : chaîne, SerialNo : chaîne, privateKey : Buffer | chaîne );
Le prestataire interroge les options de développement configurées par le commerçant

Documentation de référence

 getFapiaoDevConfigOfPartner (spMchId : chaîne, subMchId : chaîne, SerialNo : chaîne, privateKey : Buffer | chaîne) ;
Notification de facture WeChat du fournisseur de services

Documentation de référence

 fapiaoCallbackOfPartner (certs : Map<string, string>, apiKey : string, req : Request, res : Response) : Promise<FapiaoNotifyResultOfPartner> ;
Le prestataire obtient l'en-tête renseigné par l'utilisateur

Documentation de référence

 getUserTitleOfPartner (params : GetUserTitleParams, spMchId : chaîne, subMchId : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) ;
Le fournisseur de services émet une facture électronique

Documentation de référence

 issueFapiaoOfPartner (données : IssueFapiaoRequestOfPartner, spMchId : chaîne, SerialNo : chaîne, privateKey : Buffer | chaîne, platformSerial : chaîne) ;
Facture électronique de requête du fournisseur de services

Documentation de référence

 getIssueFapiaoOfPartner (fapiaoApplyId : chaîne, fapiaoId : chaîne | null | non défini, spMchId : chaîne, subMchid : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) ;
Factures électroniques rouges des prestataires de services

Documentation de référence

 reverseFapiaoOfPartner (fapiaoApplyId : chaîne, données : ReverseFapiaoRequestOfPartner, spMchId : chaîne, serialNo : chaîne, privateKey : Buffer | chaîne) ;

Fonction de l'outil de paiement WeChat

Décryptage des messages

décrypterCipherText

 decryptCipherText<T> (apiKey : chaîne, chiffrement : chaîne, AssociatedData : chaîne, nonce : chaîne) : T |

Documentation de référence

Outils de cryptage, de décryptage et de signature des messages WeChat

 importer { MessageCrypto } depuis 'nest-wechat'; const sha1 = MessageCrypto.sha1('string to hash');

Méthode statique :

  • sha1 (...args : string[]) : chaîne ;

  • md5 (texte : chaîne) : chaîne ;

  • getAESKey (encodageAESKey : chaîne) : Tampon ;

  • getAESKeyIV (aesKey : Buffer) : Tampon ;

  • PKCS7Encoder (buff : Tampon) : Tampon ;

  • PKCS7Decoder (buff : Buffer) : Tampon ;

  • décrypter (aesKey : Buffer, iv : Buffer, str : string) : chaîne ;

  • chiffrer (aesKey : Buffer, iv : Buffer, msg : string, appId : string) : chaîne ;

  • createNonceStr (longueur = 16) : chaîne ;

  • encryptMessage (appId : chaîne, jeton : chaîne, encodingAESKey : chaîne, message : chaîne, horodatage : chaîne, nonce : chaîne) : chaîne ;

  • decryptMessage (jeton : chaîne, encodingAESKey : chaîne, signature : chaîne, horodatage : chaîne, nonce : chaîne, encryptXml : chaîne) ;

  • decryptMessage (jeton : chaîne, encodingAESKey : chaîne, signature : chaîne, horodatage : chaîne, nonce : chaîne, encryptXml : chaîne) ;

  • checkSignature (signature : chaîne, horodatage : chaîne, nom occasionnel : chaîne, jeton : chaîne) ;

Exécuter le test

Créez le fichier .env.test.local et enregistrez votre application de test et votre secret dans le fichier. 

TEST_APPID=your/test/appid
TEST_SECRET=your/test/secret
TEST_JSSDK_URL=https://your/website/url
TEST_TOKEN=your/token
TEST_AESKEY=your/aeskey

REDIS_HOST=your/redis/host
REDIS_PORT=6379
REDIS_PASSWORD=
REDIS_DB=0
REDIS_TTL=600

Exécutez le test e2e.

 npm exécuter le test : e2e

Exécutez un test unitaire.

 npm exécuter le test wechat.service.userinfo.spec.ts

Test de poussée des messages

  • Démarrer les tests de service

 npx ts-node -T tests/e2e/wechat-app.main.ts

  • Configuration push des messages de compte public (plateforme de test publique WeChat), après avoir activé le test de service ci-dessus, vous pouvez réussir la vérification de la configuration

  • URL : http://votre/url/wechat/push, telle que : http://113.22.11.2:3001/wechat/push

  • Jeton : pamtest

  • Obtenez access_token à partir de l'outil de débogage de l'interface de la plateforme publique WeChat

corps

 { "grant_type": "client_credential",
"appid": "votre/appid",
"secret": "votre/secret",
"force_refresh": faux}

  • Outils de débogage sur la plateforme ouverte WeChat - outils de débogage pour les tests push de messages pour tester le push

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout