Beranda>Terkait pemrograman>Kode Sumber AI
Unduh

sarang-wechat

Akun resmi WeChat, pengembangan program WeChat, mini-game WeChat, pembayaran WeChat dan WeChat perusahaan serta enkapsulasi modul sarang API sisi server lainnya. Itu juga dapat digunakan secara langsung sebagai kelas alat.

nest-wechat adalah paket untuk bisnis penggunaan mandiri. Jika API yang Anda perlukan belum tersedia, Anda dapat mengirimkan masalahnya kepada saya dan saya akan memperbaikinya sesegera mungkin.

Dokumentasi Tiongkok

mulai cepat

Memasang

 npm i --simpan sarang-wechat

pengenalan modul nestjs

  • pendaftaran metode pendaftaran

 impor { Modul } dari '@nestjs/common';impor { WeChatModule } dari 'nest-wechat';@Module({
impor: [WeChatModule.register({appId: 'your app id', secret: 'your secret'})],})ekspor kelas AppModule {}

  • pendaftaran konfigurasi forRoot

 import { CACHE_MANAGER, Module } dari '@nestjs/common';import { ConfigModule, ConfigService } dari '@nestjs/config';import { Cache } dari 'cache-manager';import { RedisCache, WeChatModule } dari 'nest-wechat ';@Modul({
impor: [ConfigModule.forRoot({ envFilePath: '.env.test.local',}),WeChatModule.forRootAsync({ impor: [ConfigModule], menyuntikkan: [ConfigService, CACHE_MANAGER], useFactory: (configService: ConfigService, cache: Cache) => ({appId: configService.get('WX_APPID'), rahasia: configService.get('WX_SECRET'), token: configService.get('WX_TOKEN'), pengkodeanAESKey: configService.get('WX_AESKEY'), cacheAdapter: RedisCache baru(cache), debug: benar, }),}),
]})ekspor kelas AppModule {}

Pengenalan alat

 impor { WeChatService } dari 'nest-wechat';const service = new WeChatService({ appId: 'ID aplikasi Anda', rahasia: 'rahasia Anda'});

antarmuka global

sakit

 /** * Antarmuka cache, harap terapkan antarmuka ini jika Anda perlu menyesuaikan cache * * antarmuka cache, harap terapkan antarmuka ini jika Anda memerlukannya.
get<T> (kunci: string): Janji<T>;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
set (kunci: string, nilai: apa saja): batal;
hapus (kunci: string): boolean;
tutup(): batal;}

Properti dan metode WeChatService

konfigurasi: WeChatModuleOptions

Konfigurasikan properti baca dan tulis, ketik: WeChatModuleOptions

adaptor cache: ICache

Atribut baca dan tulis adaptor cache, ketik: ICache, defaultnya adalah cache yang diimplementasikan oleh Map

API akun publik WeChat

Otorisasi web

dapatkanAccessTokenByCode

 public async getAccessTokenByCode (kode: string, _appId?: string, _secret?: string): Promise<UserAccessTokenResult>;

Kembali dengan benar

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

kesalahan kembali

 {"errcode": 40029,"errmsg": "kode tidak valid"}

Dokumentasi referensi

dapatkan Info Pengguna

Akun resmi menarik informasi pengguna

 getUserInfo async publik (accessToken: string, openid: string, lang: 'zh_CN' | 'zh_TW' | 'en' = 'zh_CN'): Janji<UserInfoResult>;

Kembali dengan benar

 {
"openid": "OPENID", "nama panggilan": NICKNAME,
"jenis kelamin": 1, "provinsi":"PROVINSI", "kota":"KOTA", "negara":"NEGARA", "headimgurl":"https://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/46", "hak istimewa":[ "PRIVILEGE1" "PRIVILEGE2" ], "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"}

kesalahan kembali

 { "errcode":40003, "errmsg":" openid tidak valid "}

Dapatkan token akses

dapatkanAccountAccessToken

 getAccountAccessToken async publik (_appId?: string, _secret?: string): Janji<AccountAccessTokenResult>;

Kembali dengan benar

 { "akses_token": "52_s0Mcl3E3DBKs12rthjxG8_DOvsIC4puV9A34WQR6Bhb_30TW9W9BjhUxDRkyph-hY9Ab2QS03Q8w ZBe5UkA1k0q0hc17eUDZ7vAWItl4iahnhq_57dCoKc1dQ3AfiHUKGCCMJ2NcQ0BmbBRIKBEgAAAPGJ", "kedaluwarsa_dalam": 7200}

kesalahan kembali

 { "kode kesalahan": 40013, "errmsg": "aplikasi tidak valid"}

Dokumentasi referensi

Dapatkan kredensial panggilan antarmuka versi stabil

dapatkanStableAccessToken

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

Dokumentasi referensi

Dapatkan jsapi_ticket

dapatkanJSApiTicket

 async publik getJSApiTicket (_appId?: string, _secret?: string): Janji<TicketResult>;

Kembalikan data

 { "kode kesalahan": 0, "errmsg": "ok", "tiket": "bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA", "expires_in": 7200}

Dokumentasi referensi

JS-SDK menggunakan tanda tangan izin

jssdkSignature

 async publik jssdkSignature (url: string): Janji<SignatureResult>; async publik jssdkSignature (url: string, appId: string, rahasia:string): Janji<SignatureResult>;

Dokumentasi referensi

Kirim pesan templat

kirimTemplateMessage

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

Dokumentasi referensi

Hasilkan kode QR dengan parameter

buatQRCode

 public async createQRCode (data: AccountCreateQRCode, appId?: string, rahasia?: string): Janji<AccountCreateQRCodeResult>;

Dokumentasi referensi

Tukarkan tiket dengan kode QR

tampilkanQRCode

 pertunjukan publikQRCode (tiket: string): Promis<Buffer>;

Dokumentasi referensi

Isi konfigurasi server

checkSignatureExpress

 WeChatService.checkSignatureExpress (permintaan: Permintaan, res: Respons);

Penggunaan:

 @Get('push')async pushTest (@Req() req: Permintaan, @Res() res: Response) {
this.service.checkSignatureExpress(req, res);}

Dokumentasi referensi

Terima dorongan acara

pesanPushExpressHandler

 // Mode terenkripsi WeChatService.messagePushExpressHandler (permintaan: Permintaan, res?: Respon, resText?: string); // Mode teks biasa WeChatService.plainMessagePushExpressHandler (permintaan: Permintaan, res?: Respon, resText?: string);

Penggunaan:

 @Post('push')async officialPushTest (@Req() req: Permintaan, @Res() res: Response) {
const decrypt = tunggu this.service.messagePushExpressHandler(req, res);}

Dokumentasi referensi

apel WeChat

Dapatkan kredensial panggilan antarmuka

 getAccessToken publik (appId?: string, rahasia?: string): Janji<AccessTokenResult>;
 const service = new WeChatService({ appId: 'id aplikasi Anda', rahasia: 'rahasia Anda'}); const res = menunggu service.mp.getAccessToken();console.log(res.data.access_token);

Informasi penghapusan kueri

 getRid async publik (singkirkan: string, accessToken: string): Janji<RidInfo>;

Dapatkan pengguna plugin openpid

 public async getPluginOpenPId (kode: string, accessToken: string): Promise<DefaultRequestResult & { openpid: string }>;

Masuk ke sesi kode2

 public async code2Session (kode: string, appId?: string, rahasia?: string): Promise<SessionResult>;

Kembalikan data

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

Dokumentasi referensi

Dapatkan nomor ponsel

 getPhoneNumber async publik (kode: string, accessToken: string);

Dokumentasi referensi

Dapatkan kode appletnya

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

Dapatkan kode program mini tanpa batas

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

Dapatkan kode QR dari program mini

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

Kode skema kueri

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

Dapatkan kode skema

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

Dapatkan skema applet NFC

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

Dapatkan Tautan URL

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

Tautan URL Kueri

 public queryUrlLink (urlLink: string, accessToken: string): Janji<UrlLinkResult>;

DapatkanShortLink

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

Kirim pesan terpadu

 sendUniformMessage publik (params: SendUniformMessage, accessToken: string): Promise<DefaultRequestResult>;

Buat aktivitas_id

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

Edit Umpan Berita

 setUpdatableMsg publik (params: UpdatableMsg, accessToken: string): Janji<DefaultRequestResult>;

Hapus templat

 public deleteMessageTemplate (priTmplId: string, accessToken: string): Janji<DefaultRequestResult>;

Dapatkan kategori

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

Dapatkan daftar kata kunci

 getPubTemplateKeyWordsById publik (tid: angka, accessToken: string): Janji<PubTemplateKeyWords>;

Dapatkan templat publik di bawah kategori tempatnya

 getPubTemplateTitleList publik (params: PubTemplateTitleList, accessToken: string): Promise<PubTemplateTitleListResult>;

Dapatkan daftar template pribadi

 getMessageTemplateList publik (accessToken: string): Janji<MessageTemplateListResult>;

Kirim pesan berlangganan

 sendMessage publik (params: SendMessage, accessToken: string): Promise<DefaultRequestResult>;

Tambahkan templat

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

aplikasi seluler

Impor modul

 impor { Modul } dari '@nestjs/common';impor { WeChatMobileModule } dari 'nest-wechat';@Module({
impor: [WeChatMobileModule.register()],})ekspor kelas AppModule {}

Pengenalan alat

 impor { MobileService } dari 'nest-wechat';const service = new MobileService();

Dapatkan access_token melalui kode

 getAccessToken publik (kode: string, appId: string, rahasia: string): Promise<AxiosResponse<MobileAppAccessTokenResult, any>>;

Segarkan atau perbarui access_token

 public refreshAccessToken (appId: string, refreshToken: string): Promise<AxiosResponse<MobileAppAccessTokenResult, any>>;

Verifikasi access_token

 checkAccessToken publik (openId: string, accessToken: string): Janji<AxiosResponse<DefaultRequestResult, any>>;

Pembayaran WeChat

Program kecil

pesanan JSAPI

 pay.jsapi (pesanan: TransactionOrder, serialNo: string, privateKey: Buffer | string): Janji<{prepay_id: string}>;

Urutan permintaan nomor pesanan pedagang

 pay.getTransactionById (id: string, mchId: string, serialNo: string, privateKey: Buffer | string): Janji<Trade>;

Pesanan permintaan nomor pesanan pembayaran WeChat

 pay.getTransactionByOutTradeNo (outTradeNo: string, mchId: string, serialNo: string, privateKey: Buffer | string): Janji<Trade>;

Tutup pesanan

 pay.close (outTradeNo: string, mchId: string, serialNo: string, privateKey: Buffer | string);

Silakan tarik permohonannya

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

Minta satu pengembalian dana

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

Buatlah program kecil untuk memanggil parameter pembayaran

 pay.buildMiniProgramPayment (appId: string, prepayId: string, privateKey: Buffer | string): MiniProgramPaymentParameters;

Pengendali notifikasi pembayaran

 pay.paidCallback (publicKey: Buffer | string, apiKey: string, req: Permintaan, res: Respon): Janji<Trade>;

Pengendali pemberitahuan pengembalian dana

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

Faktur elektronik

Konfigurasikan opsi pengembangan

 pay.fapiaoDevConfig (data: DevelopmentConfigRequest, mchId: string, serialNo: string, privateKey: Buffer | string);

Kueri opsi pengembangan yang dikonfigurasi oleh pedagang

 pay.getFapiaoDevConfig (mchId: string, serialNo: string, privateKey: Buffer | string);

Buat faktur elektronik, kartu dan templat kupon

 pay.createCardTemplate (data: CreateCardTemplateRequest, mchId: string, serialNo: string, privateKey: Buffer | string);

Pemberitahuan faktur WeChat

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

Dapatkan header diisi oleh pengguna

 pay.getUserTitle (params: GetUserTitleParams, mchId: string, serialNo: string, privateKey: Buffer | string);

Menerbitkan faktur elektronik

 pay.issueFapiao (data: IssueFapiaoRequest, mchId: string, serialNo: string, privateKey: Buffer | string);

Permintaan faktur elektronik

 pay.getIssueFapiao (fapiaoApplyId: string, fapiaoId: string, mchId: string, serialNo: string, privateKey: Buffer | string);

faktur elektronik merah

 pay.reverseFapiao (fapiaoApplyId: string, data: ReverseFapiaoRequest, mchId: string, serialNo: string, privateKey: Buffer | string);

Enkripsi dan dekripsi informasi sensitif

enkripsi

 pay.rsaEncryptOAEP (teks: string, publicKey: Buffer | string);

Dekripsi

 pay.rsaDecryptOAEP (cipherText: string, privateKey: Buffer | string);

amplop merah tunai

Tidak ada pedagang pengujian yang tersedia dan pengujian belum berhasil. Silakan uji sendiri. Jika Anda memiliki pertanyaan, silakan kirimkan masalah.

Pengujian dapat menjalankan pengujian unit dengan sendirinya (perlu mengubah konfigurasi)

 npm jalankan tes lib/wepay.hb.spec.ts

membagikan amplop merah

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

Bagikan pembagian amplop merah

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

Kueri catatan amplop merah

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

Penyedia layanan pembayaran WeChat

Pesanan JSAPI penyedia layanan

Dokumentasi referensi

 jsapiOfPartner (pesanan: TransactionOrderOfPartner, serialNo: string, privateKey: Buffer | string);

Penyedia layanan JSAPI memanggil pembayaran

Dokumentasi referensi

Bangun antarmuka untuk memanggil parameter pembayaran WeChat

 buildJSAPIParameters (appId: string, prepayId: string, privateKey: Buffer | string): MiniProgramPaymentParameters;

Pemberitahuan pembayaran penyedia layanan

Dokumentasi referensi

 dibayarCallbackOfPartner (sertifikat: Peta<string, string>, apiKey: string, req: Permintaan, res: Respon): Promise<TradeOfPartner>;

Penyedia layanan menutup pesanan

Dokumentasi referensi

 closeOfPartner (outTradeNo: string, spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);

Pesanan permintaan nomor pesanan pembayaran WeChat penyedia layanan

Dokumentasi referensi

 getTransactionByIdOfPartner (id: string, spMchId: string, subMchid: string, serialNo: string, privateKey: Buffer | string);

Pesanan permintaan nomor pesanan pedagang penyedia layanan

Dokumentasi referensi

 getTransactionByOutTradeNoOfPartner (outTradeNo: string, spMchId: string, subMchid: string, serialNo: string, privateKey: Buffer | string);

Aplikasi pengembalian dana penyedia layanan

Dokumentasi referensi

 refundOfPartner (pengembalian dana: RequireOnlyOne<RefundParametersOfPartner, 'transaction_id' | 'out_trade_no'>, spMchId: string, serialNo: string, privateKey: Buffer | string);

Penyedia layanan menanyakan tentang pengembalian dana tunggal

Dokumentasi referensi

 getRefundOfPartner (outRefundNo: string, spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);

Pemberitahuan hasil pengembalian dana penyedia layanan

Dokumentasi referensi

 refundedCallbackOfPartner (sertifikat: Map<string, string>, apiKey: string, req: Request, res: Response): Promise<RefundNotifyResultOfPartner>;

Faktur elektronik penyedia layanan

Penyedia layanan membuat faktur elektronik, kartu dan templat kupon

Dokumentasi referensi

 createCardTemplateOfPartner (data: CreateCardTemplateRequestOfPartner, spMchId: string, serialNo: string, privateKey: Buffer | string);
Opsi pengembangan konfigurasi penyedia layanan

Dokumentasi referensi

 fapiaoDevConfigOfPartner (data: DevelopmentConfigRequestOfPartner, spMchId: string, serialNo: string, privateKey: Buffer | string);
Penyedia layanan menanyakan opsi pengembangan yang dikonfigurasi oleh pedagang

Dokumentasi referensi

 getFapiaoDevConfigOfPartner (spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);
Pemberitahuan faktur WeChat penyedia layanan

Dokumentasi referensi

 fapiaoCallbackOfPartner (sertifikat: Map<string, string>, apiKey: string, req: Request, res: Response): Promise<FapiaoNotifyResultOfPartner>;
Penyedia layanan memperoleh header yang diisi oleh pengguna

Dokumentasi referensi

 getUserTitleOfPartner (params: GetUserTitleParams, spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);
Penyedia layanan menerbitkan faktur elektronik

Dokumentasi referensi

 issueFapiaoOfPartner (data: IssueFapiaoRequestOfPartner, spMchId: string, serialNo: string, privateKey: Buffer | string, platformSerial: string);
Penyedia layanan menanyakan faktur elektronik

Dokumentasi referensi

 getIssueFapiaoOfPartner (fapiaoApplyId: string, fapiaoId: string | null | tidak terdefinisi, spMchId: string, subMchid: string, serialNo: string, privateKey: Buffer | string);
Penyedia layanan faktur elektronik merah

Dokumentasi referensi

 reverseFapiaoOfPartner (fapiaoApplyId: string, data: ReverseFapiaoRequestOfPartner, spMchId: string, serialNo: string, privateKey: Buffer | string);

Fungsi alat pembayaran WeChat

Dekripsi pesan

mendekripsiCipherText

 decryptCipherText<T> (apiKey: string, sandi: string, data terkait: string, nonce: string): T | string;

Dokumentasi referensi

Alat enkripsi, dekripsi, dan tanda tangan pesan WeChat

 import { MessageCrypto } dari 'nest-wechat';const sha1 = MessageCrypto.sha1('string ke hash');

Metode statis:

  • sha1 (...args: string[]): string;

  • md5 (teks: string): string;

  • getAESKey (pengkodeanAESKey: string): Buffer;

  • getAESKeyIV (aesKey: Penyangga): Penyangga;

  • PKCS7Encoder (penggemar: Penyangga): Penyangga;

  • PKCS7Decoder (penggemar: Buffer): Penyangga;

  • mendekripsi (aesKey: Buffer, iv: Buffer, str: string): string;

  • mengenkripsi (aesKey: Buffer, iv: Buffer, pesan: string, appId: string): string;

  • createNonceStr (panjang = 16): string;

  • encryptMessage (appId: string, token: string, pengkodeanAESKey: string, pesan: string, stempel waktu: string, nonce: string): string;

  • decryptMessage (token: string, pengkodeanAESKey: string, tanda tangan: string, stempel waktu: string, nonce: string, encryptXml: string);

  • decryptMessage (token: string, pengkodeanAESKey: string, tanda tangan: string, stempel waktu: string, nonce: string, encryptXml: string);

  • checkSignature (tanda tangan: string, stempel waktu: string, nonce: string, token: string);

Jalankan Tes

Buat file .env.test.local, dan simpan aplikasi pengujian dan rahasia Anda di file tersebut. 

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

Jalankan tes e2e.

 npm menjalankan tes:e2e

Jalankan pengujian unit.

 npm jalankan tes wechat.service.userinfo.spec.ts

Tes dorong pesan

  • Mulai pengujian layanan

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

  • Konfigurasi push pesan akun publik (platform pengujian publik WeChat), setelah mengaktifkan pengujian layanan di atas, Anda dapat melewati verifikasi konfigurasi

  • URL: http://your/url/wechat/push, seperti: http://113.22.11.2:3001/wechat/push

  • Token: tes pamtest

  • Dapatkan access_token dari alat debugging antarmuka platform publik WeChat

tubuh

 { "grant_type": "kredensial_klien",
"appid": "Anda/appid",
"rahasia": "rahasia/Anda",
"force_refresh": salah}

  • Alat debugging pada platform terbuka WeChat - alat debugging untuk pengujian push pesan untuk menguji push

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua