Página Inicial>Relacionado com a programação>Código-Fonte de IA
Baixar

ninho-wechat

Conta oficial do WeChat, desenvolvimento do programa WeChat, minijogos WeChat, pagamento WeChat e WeChat corporativo e outros encapsulamentos de módulo API nestjs do lado do servidor. Também pode ser usado diretamente como uma classe de ferramenta.

nest-wechat é um pacote para negócios de uso próprio. Se a API que você precisa usar ainda não estiver disponível, você pode enviar problemas para mim e eu resolverei isso o mais rápido possível.

Documentação chinesa

início rápido

Instalar

 npm i --save ninho-wechat

introdução do módulo nestjs

  • registrar método de registro

 importar { Módulo } de '@nestjs/common';importar { WeChatModule } de 'nest-wechat';@Module({
importa: [WeChatModule.register({appId: 'seu ID do aplicativo', segredo: 'seu segredo'})],})export class AppModule {}

  • registro de configuração forRoot

 importar { CACHE_MANAGER, Módulo } de '@nestjs/common';importar { ConfigModule, ConfigService } de '@nestjs/config';importar { Cache } de 'cache-manager';importar { RedisCache, WeChatModule } de 'nest-wechat ';@Módulo({
importações: [ConfigModule.forRoot({ envFilePath: '.env.test.local',}),WeChatModule.forRootAsync({ importações: [ConfigModule], injetar: [ConfigService, CACHE_MANAGER], useFactory: (configService: ConfigService, cache: Cache) => ({appId: configService.get('WX_APPID'), segredo: configService.get('WX_SECRET'), token: configService.get('WX_TOKEN'), encodingAESKey: configService.get('WX_AESKEY'), cacheAdapter: novo RedisCache(cache), depuração: verdadeiro, }),}),
]})exportar classe AppModule {}

Introdução de ferramentas

 import { WeChatService } from 'nest-wechat'; const service = new WeChatService ({ appId: 'seu ID do aplicativo', secret: 'seu segredo'});

interface global

ICache

 /** * Interface de cache, implemente esta interface se precisar personalizar o cache * * interface de cache, implemente esta interface se precisar.
get<T> (chave: string): Promessa<T>;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
set (chave: string, valor: qualquer): void;
remover (chave: string): booleano;
fechar(): vazio;}

Propriedades e métodos do WeChatService

configuração: WeChatModuleOptions

Configure propriedades de leitura e gravação, digite: WeChatModuleOptions

cacheAdapter: ICache

Atributos de leitura e gravação do adaptador de cache, tipo: ICache, o padrão é um cache implementado pelo Map

API de conta pública WeChat

Autorização web

getAccessTokenByCode

 getAccessTokenByCode assíncrono público (código: string, _appId?: string, _secret?: string): Promise<UserAccessTokenResult>;

Retorne corretamente

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

retorno de erro

 {"errcode": 40029,"errmsg": "código inválido"}

Documentação de referência

getUserInfo

Conta oficial extrai informações do usuário

 getUserInfo assíncrono público (accessToken: string, openid: string, lang: 'zh_CN' | 'zh_TW' | 'en' = 'zh_CN'): Promise<UserInfoResult>;

Retorne corretamente

 {
"openid": "OPENID", "apelido": NICKNAME,
"sexo": 1, "província":"PROVÍNCIA", "cidade":"CIDADE", "país":"PAÍS", "headimgurl":"https://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUFpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/46", "privilégio":[ "PRIVILEGE1" "PRIVILEGE2"], "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"}

retorno de erro

 { "errcode":40003, "errmsg":"openid inválido"}

Obtenha token de acesso

getAccountAccessToken

 getAccountAccessToken assíncrono público (_appId?: string, _secret?: string): Promise<AccountAccessTokenResult>;

Retorne corretamente

 { "token_acesso": "52_s0Mcl3E3DBKs12rthjxG8_DOvsIC4puV9A34WQR6Bhb_30TW9W9BjhUxDRkyph-hY9Ab2QS03Q8w ZBe5UkA1k0q0hc17eUDZ7vAWItl4iahnhq_57dCoKc1dQ3AfiHUKGCCMJ2NcQ0BmbBRIKBEgAAAPGJ", "expira_em": 7200}

retorno de erro

 { "código de erro": 40013, "errmsg": "aplicativo inválido"}

Documentação de referência

Obtenha credenciais de chamada de interface de versão estável

getStableAccessToken

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

Documentação de referência

Obtenha jsapi_ticket

getJSApiTicket

 getJSApiTicket assíncrono público (_appId?: string, _secret?: string): Promise<TicketResult>;

Dados de retorno

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

Documentação de referência

JS-SDK usa assinatura de permissão

jssdkSignature

 public async jssdkSignature (url: string): Promise<SignatureResult>; public async jssdkSignature (url: string, appId: string, secret:string): Promise<SignatureResult>;

Documentação de referência

Enviar modelo de mensagem

enviarTemplateMessage

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

Documentação de referência

Gere código QR com parâmetros

criarQRCode

 createQRCode assíncrono público (dados: AccountCreateQRCode, appId?: string, secret?: string): Promise<AccountCreateQRCodeResult>;

Documentação de referência

Troque ingressos por códigos QR

mostrarQRCode

 public showQRCode (ticket: string): Promis<Buffer>;

Documentação de referência

Preencha a configuração do servidor

verificarSignatureExpress

 WeChatService.checkSignatureExpress (req: Solicitação, res: Resposta);

Uso:

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

Documentação de referência

Receber push do evento

mensagemPushExpressHandler

 // Modo criptografado WeChatService.messagePushExpressHandler (req: Request, res?: Response, resText?: string); // Modo de texto simples WeChatService.plainMessagePushExpressHandler (req: Request, res?: Response, resText?: string);

Uso:

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

Documentação de referência

Miniaplicativo WeChat

Obtenha credenciais de chamada de interface

 public getAccessToken (appId?: string, secret?: string): Promise<AccessTokenResult>;
 const service = new WeChatService({appId: 'seu ID do aplicativo', secret: 'seu segredo'});

Consultar informações de eliminação

 getRid assíncrono público (livrar: string, accessToken: string): Promise<RidInfo>;

Obtenha o usuário do plugin openpid

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

Faça login no code2Session

 code2Session assíncrono público (código: string, appId?: string, segredo?: string): Promise<SessionResult>;

Dados de retorno

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

Documentação de referência

Obtenha o número do celular

 getPhoneNumber assíncrono público (código: string, accessToken: string);

Documentação de referência

Obtenha o código do miniaplicativo

 getQRCode assíncrono público (parâmetros: QRCode, accessToken: string): Promise<DefaultRequestResult & { contentType: string, buffer: Buffer }>;

Obtenha minicódigos de programa ilimitados

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

Obtenha o código QR do miniprograma

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

Código do esquema de consulta

 queryScheme assíncrono público (esquema: string, accessToken: string): Promise<DefaultRequestResult & {esquema_info: SchemeInfo, esquema_quota: SchemeQuota }>;

Obtenha o código do esquema

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

Obtenha o esquema do miniaplicativo NFC

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

Obter URLLink

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

Consultar URLLink

 consulta públicaUrlLink (urlLink: string, accessToken: string): Promise<UrlLinkResult>;

ObterShortLink

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

Envie mensagens unificadas

 public sendUniformMessage (parâmetros: SendUniformMessage, accessToken: string): Promise<DefaultRequestResult>;

Criar atividade_id

 public createActivityId (parâmetros: CreateActivityId, accessToken: string): Promise<ActivityIdResult>;

Editar feed de notícias

 public setUpdatableMsg (parâmetros: UpdatableMsg, accessToken: string): Promise<DefaultRequestResult>;

Excluir modelo

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

Obter categoria

 public getCategory (accessToken: string): Promise<DefaultRequestResult & {dados: {id: número, nome: string}[] }>;

Obtenha lista de palavras-chave

 public getPubTemplateKeyWordsById (tid: número, accessToken: string): Promise<PubTemplateKeyWords>;

Obtenha modelos públicos na categoria a que pertencem

 public getPubTemplateTitleList (parâmetros: PubTemplateTitleList, accessToken: string): Promise<PubTemplateTitleListResult>;

Obtenha uma lista pessoal de modelos

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

Enviar mensagem de assinatura

 public sendMessage (parâmetros: SendMessage, accessToken: string): Promise<DefaultRequestResult>;

Adicionar modelo

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

aplicativo móvel

Importação de módulo

 importar { Módulo } de '@nestjs/common';importar { WeChatMobileModule } de 'nest-wechat';@Module({
importações: [WeChatMobileModule.register()],})exportar classe AppModule {}

Introdução de ferramentas

 importar {MobileService} de 'nest-wechat';const service = new MobileService();

Obtenha access_token através do código

 public getAccessToken (código: string, appId: string, segredo: string): Promise<AxiosResponse<MobileAppAccessTokenResult, any>>;

Atualizar ou renovar access_token

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

Verifique access_token

 checkAccessToken público (openId: string, accessToken: string): Promise<AxiosResponse<DefaultRequestResult, any>>;

Pagamento WeChat

Miniprograma

Pedido JSAPI

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

Pedido de consulta do número do pedido do comerciante

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

Pedido de consulta do número da ordem de pagamento WeChat

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

Fechar pedido

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

Por favor retire o aplicativo

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

Consultar um único reembolso

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

Construa um pequeno programa para acessar parâmetros de pagamento

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

Manipulador de notificação de pagamento

 pay.paidCallback (publicKey: Buffer | string, apiKey: string, req: Solicitação, res: Resposta): Promise<Trade>;

Gerenciador de notificação de reembolso

 pay.refundedCallback (certificados: Mapa<string, string>, apiKey: string, req: Solicitação, res: Resposta): Promise<RefundNotifyResult>;

Fatura eletrônica

Configurar opções de desenvolvimento

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

Consultar as opções de desenvolvimento configuradas pelo lojista

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

Crie fatura eletrônica, cartão e modelo de cupom

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

Notificação de fatura WeChat

 pay.fapiaoCallback (certificados: Mapa<string, string>, apiKey: string, req: Solicitação, res: Resposta): Promise<FapiaoNotifyResult>;

Obtenha o cabeçalho preenchido pelo usuário

 pay.getUserTitle (parâmetros: GetUserTitleParams, mchId: string, serialNo: string, privateKey: Buffer | string);

Emitir faturas eletrônicas

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

Consultar fatura eletrónica

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

fatura eletrônica vermelha

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

Criptografia e descriptografia de informações confidenciais

criptografia

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

Descriptografar

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

envelope vermelho em dinheiro

Não há comerciantes de teste disponíveis e o teste não foi bem-sucedido. Teste você mesmo. Se você tiver alguma dúvida, envie um problema.

O teste pode executar testes unitários sozinho (é necessário modificar a configuração)

 npm executa teste lib/wepay.hb.spec.ts

distribuir envelopes vermelhos

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

Distribua envelopes vermelhos de fissão

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

Consultar registros de envelope vermelho

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

Provedor de serviços de pagamento WeChat

Pedido JSAPI do provedor de serviços

Documentação de referência

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

O provedor de serviços JSAPI solicita pagamento

Documentação de referência

Crie uma interface para chamar parâmetros de pagamento do WeChat

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

Notificação de pagamento do provedor de serviços

Documentação de referência

 pagoCallbackOfPartner (certificados: Mapa<string, string>, apiKey: string, req: Solicitação, res: Resposta): Promise<TradeOfPartner>;

Prestador de serviços fecha pedido

Documentação de referência

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

Pedido de consulta do número da ordem de pagamento WeChat do provedor de serviços

Documentação de referência

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

Pedido de consulta do número do pedido do comerciante do provedor de serviços

Documentação de referência

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

Solicitação de reembolso do provedor de serviços

Documentação de referência

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

O provedor de serviços pergunta sobre um único reembolso

Documentação de referência

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

Notificação de resultado de reembolso do provedor de serviços

Documentação de referência

 refundedCallbackOfPartner (certificados: Mapa<string, string>, apiKey: string, req: Solicitação, res: Resposta): Promise<RefundNotifyResultOfPartner>;

Fatura eletrônica do prestador de serviços

Prestador de serviços cria modelo de fatura eletrônica, cartão e cupom

Documentação de referência

 createCardTemplateOfPartner (dados: CreateCardTemplateRequestOfPartner, spMchId: string, serialNo: string, privateKey: Buffer | string);
Opções de desenvolvimento de configuração do provedor de serviços

Documentação de referência

 fapiaoDevConfigOfPartner (dados: DevelopmentConfigRequestOfPartner, spMchId: string, serialNo: string, privateKey: Buffer | string);
O prestador de serviço consulta as opções de desenvolvimento configuradas pelo lojista

Documentação de referência

 getFapiaoDevConfigOfPartner (spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);
Notificação de fatura WeChat do provedor de serviços

Documentação de referência

 fapiaoCallbackOfPartner (certificados: Mapa<string, string>, apiKey: string, req: Solicitação, res: Resposta): Promise<FapiaoNotifyResultOfPartner>;
O provedor de serviço obtém o cabeçalho preenchido pelo usuário

Documentação de referência

 getUserTitleOfPartner (parâmetros: GetUserTitleParams, spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);
Prestador de serviços emite nota fiscal eletrônica

Documentação de referência

 issueFapiaoOfPartner (dados: IssueFapiaoRequestOfPartner, spMchId: string, serialNo: string, privateKey: Buffer | string, platformSerial: string);
Prestador de serviço consulta nota fiscal eletrônica

Documentação de referência

 getIssueFapiaoOfPartner (fapiaoApplyId: string, fapiaoId: string | nulo | indefinido, spMchId: string, subMchid: string, serialNo: string, privateKey: Buffer | string);
Faturas eletrônicas vermelhas de prestadores de serviços

Documentação de referência

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

Função da ferramenta de pagamento WeChat

Descriptografia de mensagem

descriptografarCipherText

 decryptCipherText<T> (apiKey: string, cifra: string, AssociateData: string, nonce: string): T |

Documentação de referência

Ferramentas de criptografia, descriptografia e assinatura de mensagens WeChat

 importar {MessageCrypto} de 'nest-wechat'; const sha1 = MessageCrypto.sha1('string para hash');

Método estático:

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

  • md5 (texto: string): string;

  • getAESKey (encodingAESKey: string): Buffer;

  • getAESKeyIV (aesKey: Buffer): Buffer;

  • PKCS7Encoder (buff: Buffer): Buffer;

  • PKCS7Decoder (buff: Buffer): Buffer;

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

  • criptografar (aesKey: Buffer, iv: Buffer, msg: string, appId: string): string;

  • createNonceStr (comprimento = 16): string;

  • encryptMessage (appId: string, token: string, encodingAESKey: string, mensagem: string, timestamp: string, nonce: string): string;

  • decryptMessage (token: string, encodingAESKey: string, assinatura: string, timestamp: string, nonce: string, encryptXml: string);

  • decryptMessage (token: string, encodingAESKey: string, assinatura: string, timestamp: string, nonce: string, encryptXml: string);

  • checkSignature (assinatura: string, carimbo de data/hora: string, nonce: string, token: string);

Executar teste

Crie o arquivo .env.test.local e salve seu appid e segredo de teste no arquivo. 

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

Execute o teste e2e.

 teste de execução npm: e2e

Execute o teste de unidade.

 npm executa teste wechat.service.userinfo.spec.ts

Teste de envio de mensagem

  • Iniciar teste de serviço

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

  • Configuração push de mensagem de conta pública (plataforma de teste público WeChat), após ativar o teste de serviço acima, você pode passar na verificação de configuração

  • URL: http://seu/url/wechat/push, como: http://113.22.11.2:3001/wechat/push

  • Token: pamtest

  • Obtenha access_token da ferramenta de depuração da interface da plataforma pública WeChat

corpo

 { "grant_type": "client_credential",
"appid": "seu/appid",
"segredo": "seu/segredo",
"force_refresh": falso}

  • Ferramentas de depuração na plataforma aberta WeChat - ferramentas de depuração para teste de envio de mensagens para teste de envio

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos