nest wechat

nido-wechat

Cuenta oficial de WeChat, apertura del programa WeChat, minijuegos de WeChat, pago de WeChat y WeChat empresarial y otras encapsulaciones de módulos API nestjs del lado del servidor. También se puede utilizar directamente como clase de herramienta.

nest-wechat es un paquete para empresas de uso propio. Si la API que necesita utilizar aún no está disponible, puede enviarme los problemas y lo solucionaré lo antes posible.

_{documentación china}

inicio rápido

Instalar

 npm i --guardar nido-wechat

introducción al módulo nestjs

• registro método registro

 importar {Módulo} desde '@nestjs/common';importar {WeChatModule} desde 'nest-wechat';@Module({
importaciones: [WeChatModule.register({appId: 'tu ID de aplicación', secreto: 'tu secreto'})],}) clase de exportación AppModule {}

• para registro de configuración raíz

 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({
importaciones: [ConfigModule.forRoot({ envFilePath: '.env.test.local',}),WeChatModule.forRootAsync({ importaciones: [ConfigModule], inyectar: ​​[ConfigService, CACHE_MANAGER], useFactory: (configService: ConfigService, caché: caché) => ({appId: configService.get('WX_APPID'), secreto: configService.get('WX_SECRET'), token: configService.get('WX_TOKEN'), codificaciónAESKey: configService.get('WX_AESKEY'), cacheAdapter: nuevo RedisCache(caché), depurar: verdadero, }),}),
]}) clase de exportación AppModule {}

Introducción de herramientas.

 importar { WeChatService } desde 'nest-wechat'; const service = new WeChatService({ appId: 'tu ID de aplicación', secreto: 'tu secreto'});

interfaz global

ICache

 /** * Interfaz de caché, implemente esta interfaz si necesita personalizar el caché * * interfaz de caché, implemente esta interfaz si es necesario * */exportar interfaz ICache {.
get<T> (clave: cadena): Promesa<T>;
// eslint-deshabilitar-siguiente-línea @typescript-eslint/no-explicit-any
set (clave: cadena, valor: cualquiera): void;
eliminar (clave: cadena): booleano;
cerrar (): nulo;}

Propiedades y métodos de WeChatService

configuración: WeChatModuleOptions

Configure propiedades de lectura y escritura, escriba: WeChatModuleOptions

Adaptador de caché: ICache

Atributos de lectura y escritura del adaptador de caché, tipo: ICache, el valor predeterminado es un caché implementado por Map

API de cuenta pública de WeChat

Autorización de página web

obtenerTokendeAccesoPorCódigo

 getAccessTokenByCode asíncrono público (código: cadena, _appId?: cadena, _secret?: cadena): Promesa<UserAccessTokenResult>;

Regresar correctamente

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

retorno de error

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

Documentación de referencia

obtener información de usuario

La cuenta oficial extrae información del usuario

 getUserInfo async público (accessToken: cadena, openid: cadena, idioma: 'zh_CN' | 'zh_TW' | 'en' = 'zh_CN'): Promesa<UserInfoResult>;

Regresar correctamente

 {
"openid": "OPENID", "apodo": APODO,
"sexo": 1, "provincia":"PROVINCIA", "ciudad":"CIUDAD", "país":"PAÍS", "headimgurl":"https://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/46", "privilegio":[ "PRIVILEGIO1" "PRIVILEGIO2" ], "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"}

retorno de error

 { "errcode": 40003, "errmsg": "openid no válido"}

Obtener token de acceso

obtenerToken de acceso a cuenta

 getAccountAccessToken público asíncrono (_appId?: cadena, _secret?: cadena): Promesa<AccountAccessTokenResult>;

Regresar correctamente

 { "token_acceso": "52_s0Mcl3E3DBKs12rthjxG8_DOvsIC4puV9A34WQR6Bhb_30TW9W9BjhUxDRkyph-hY9Ab2QS03Q8w ZBe5UkA1k0q0hc17eUDZ7vAWItl4iahnhq_57dCoKc1dQ3AfiHUKGCCMJ2NcQ0BmbBRIKBEgAAAPGJ", "expire_in": 7200}

retorno de error

 { "errcode": 40013, "errmsg": "aplicación no válida"}

Documentación de referencia

Obtener credenciales de llamada de interfaz de versión estable

obtener token de acceso estable

 getStableAccessToken público asíncrono (_appId?: cadena, _secret?: cadena, fuerza = falso): Promesa<AccountAccessTokenResult>;

Documentación de referencia

Obtener jsapi_ticket

obtenerJSApiTicket

 getJSApiTicket asíncrono público (_appId?: cadena, _secret?: cadena): Promesa<TicketResult>;

Datos de devolución

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

Documentación de referencia

JS-SDK usa firma de permiso

jssdkFirma

 jssdkSignature asíncrono público (url: cadena): Promesa<Resultado de la firma>;

Documentación de referencia

Enviar mensaje de plantilla

enviar mensaje de plantilla

 sendTemplateMessage asíncrono público (mensaje: TemplateMessage, appId?: cadena, secreto?: cadena): Promise<DefaultRequestResult & {msgid: string}>;

Documentación de referencia

Generar código QR con parámetros

crearcódigoQR

 createQRCode asíncrono público (datos: AccountCreateQRCode, appId?: cadena, secreto?: cadena): Promesa<AccountCreateQRCodeResult>;

Documentación de referencia

Canjear billetes por códigos QR

mostrar código QR

 showQRCode público (boleto: cadena): Promis<Buffer>;

Documentación de referencia

Complete la configuración del servidor

comprobarFirmaExpress

 WeChatService.checkSignatureExpress (req: Solicitud, res: Respuesta);

Uso:

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

Documentación de referencia

Recibir push de evento

mensajePushExpressHandler

 // Modo cifrado WeChatService.messagePushExpressHandler (req: Solicitud, res?: Respuesta, resText?: cadena); // Modo texto sin formato WeChatService.plainMessagePushExpressHandler (req: Solicitud, res?: Respuesta, resText?: cadena);

Uso:

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

Documentación de referencia

subprograma WeChat

Obtener credenciales de llamada de interfaz

 getAccessToken público (appId?: cadena, ¿secreto?: cadena): Promesa<AccessTokenResult>;

 const service = new WeChatService({ appId: 'tu ID de aplicación', secreto: 'tu secreto'}); const res = await service.mp.getAccessToken();console.log(res.data.access_token);

Consultar información de eliminación

 getRid asíncrono público (deshacerse: cadena, accessToken: cadena): Promesa<RidInfo>;

Obtener el usuario del complemento openpid

 getPluginOpenPId asíncrono público (código: cadena, accessToken: cadena): Promise<DefaultRequestResult & { openpid: string }>;

Código de inicio de sesión2Sesión

 código asíncrono público2Session (código: cadena, appId?: cadena, secreto?: cadena): Promesa<SessionResult>;

Datos de devolución

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

Documentación de referencia

Obtener número de móvil

 getPhoneNumber asíncrono público (código: cadena, accessToken: cadena);

Documentación de referencia

Obtener el código del subprograma

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

Obtenga códigos de mini programas ilimitados

 getUnlimitedQRCode público (parámetros: GetUnlimitedQRCode, accessToken: cadena): Promise<DefaultRequestResult & { buffer: Buffer }>;

Obtén el código QR del mini programa

 createQRCode asíncrono público (parámetros: CreateQRCode, accessToken: string): Promise<DefaultRequestResult & { contentType: string, buffer: Buffer }>;

Código de esquema de consulta

 esquema de consulta asíncrono público (esquema: cadena, accessToken: cadena): Promise<DefaultRequestResult & { esquema_info: SchemeInfo, esquema_quota: SchemeQuota }>;

Obtener código de esquema

 generarScheme público (parámetros: GenerateScheme, accessToken: cadena): Promise<DefaultRequestResult & {openlink: cadena>;

Obtener esquema de subprograma NFC

 generarNFCScheme público (parámetros: GenerateNFCScheme, accessToken: cadena): Promise<DefaultRequestResult & {openlink: string}>;

Obtener enlace URL

 generarUrlLink público (parámetros: GenerateUrlLink, accessToken: cadena): Promise<DefaultRequestResult & {url_link: cadena}>;

URL de consultaEnlace

 queryUrlLink público (urlLink: cadena, accessToken: cadena): Promesa<UrlLinkResult>;

Obtener enlace corto

 generarShortLink público (parámetros: GenerateShortLink, accessToken: cadena): Promise<DefaultRequestResult & {enlace: cadena}>;

Enviar mensajes unificados

 sendUniformMessage público (parámetros: SendUniformMessage, accessToken: cadena): Promise<DefaultRequestResult>;

Crear id_actividad

 createActivityId público (parámetros: CreateActivityId, accessToken: cadena): Promise<ActivityIdResult>;

Editar sección de noticias

 setUpdatableMsg público (parámetros: UpdatableMsg, accessToken: cadena): Promise<DefaultRequestResult>;

Eliminar plantilla

 eliminarMessageTemplate público (priTmplId: cadena, accessToken: cadena): Promesa<DefaultRequestResult>;

Obtener categoría

 getCategory pública (accessToken: cadena): Promise<DefaultRequestResult & {datos: {id: número, nombre: cadena}[] }>;

Obtener lista de palabras clave

 getPubTemplateKeyWordsById público (tid: número, accessToken: cadena): Promesa<PubTemplateKeyWords>;

Obtener plantillas públicas bajo la categoría a la que pertenecen

 getPubTemplateTitleList público (parámetros: PubTemplateTitleList, accessToken: cadena): Promesa<PubTemplateTitleListResult>;

Obtener lista de plantillas personales

 getMessageTemplateList público (accessToken: cadena): Promesa<MessageTemplateListResult>;

Enviar mensaje de suscripción

 sendMessage público (parámetros: SendMessage, accessToken: cadena): Promise<DefaultRequestResult>;

Agregar plantilla

 addMessageTemplate público (parámetros: MessageTemplate, accessToken: cadena): Promise<DefaultRequestResult & { priTmplId: string }>;

aplicación móvil

Importación de módulos

 importar {Módulo} desde '@nestjs/common';importar {WeChatMobileModule} desde 'nest-wechat';@Module({
importaciones: [WeChatMobileModule.register()],}) clase de exportación AppModule {}

Introducción de herramientas.

 importar {MobileService} desde 'nest-wechat'; servicio constante = nuevo MobileService();

Obtenga access_token a través del código

 getAccessToken público (código: cadena, appId: cadena, secreto: cadena): Promesa<AxiosResponse<MobileAppAccessTokenResult, cualquiera>>;

Actualizar o renovar access_token

 refresco públicoAccessToken (appId: cadena, refrescoToken: cadena): Promesa<AxiosResponse<MobileAppAccessTokenResult, cualquiera>>;

Verificar token_acceso

 checkAccessToken público (openId: cadena, accessToken: cadena): Promesa<AxiosResponse<DefaultRequestResult, cualquiera>>;

Pago WeChat

Mini programa

orden JSAPI

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

Orden de consulta del número de pedido del comerciante

 pay.getTransactionById (id: cadena, mchId: cadena, serialNo: cadena, privateKey: Buffer | cadena): Promesa<Comercio>;

Orden de consulta del número de orden de pago de WeChat

 pay.getTransactionByOutTradeNo (outTradeNo: cadena, mchId: cadena, serialNo: cadena, privateKey: Buffer | cadena): Promesa<Comercio>;

Cerrar orden

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

Por favor retire la solicitud

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

Consultar un reembolso único

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

Construya un pequeño programa para recuperar parámetros de pago.

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

Manejador de notificaciones de pago

 pay.paidCallback (publicKey: Buffer | cadena, apiKey: cadena, req: Solicitud, res: Respuesta): Promesa<Comercio>;

Manejador de notificaciones de reembolso

 pay.refundedCallback (certificados: Mapa<cadena, cadena>, apiKey: cadena, req: Solicitud, res: Respuesta): Promesa<RefundNotifyResult>;

factura electrónica

Configurar opciones de desarrollo

 pay.fapiaoDevConfig (datos: DevelopmentConfigRequest, mchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Consultar las opciones de desarrollo configuradas por el comerciante

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

Crear plantilla de factura electrónica, tarjeta y cupón.

 pay.createCardTemplate (datos: CreateCardTemplateRequest, mchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Notificación de factura WeChat

 pay.fapiaoCallback (certificados: Mapa<cadena, cadena>, apiKey: cadena, req: Solicitud, res: Respuesta): Promesa<FapiaoNotifyResult>;

Obtener el encabezado completado por el usuario

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

Emitir facturas electrónicas

 pay.issueFapiao (datos: IssueFapiaoRequest, mchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Consulta factura electrónica

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

factura electrónica roja

 pay.reverseFapiao (fapiaoApplyId: cadena, datos: ReverseFapiaoRequest, mchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Cifrado y descifrado de información sensible

cifrado

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

Descifrar

 pay.rsaDecryptOAEP (texto cifrado: cadena, clave privada: búfer | cadena);

sobre rojo en efectivo

No hay comerciantes de prueba disponibles y la prueba no fue exitosa. Pruébelo usted mismo. Si tiene alguna pregunta, envíe un problema.

La prueba puede ejecutar pruebas unitarias por sí sola (es necesario modificar la configuración)

 npm ejecuta prueba lib/wepay.hb.spec.ts

repartir sobres rojos

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

Distribuir sobres rojos de fisión.

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

Consultar registros de sobre rojo

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

Proveedor de servicios de pago WeChat

Pedido JSAPI del proveedor de servicios

Documentación de referencia

 jsapiOfPartner (orden: TransactionOrderOfPartner, serialNo: cadena, privateKey: Buffer | cadena);

El proveedor de servicios JSAPI solicita el pago

Documentación de referencia

Cree una interfaz para llamar a los parámetros de pago de WeChat

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

Notificación de pago del proveedor de servicios

Documentación de referencia

 pagadoCallbackOfPartner (certificados: Mapa<cadena, cadena>, apiKey: cadena, req: Solicitud, res: Respuesta): Promesa<TradeOfPartner>;

El proveedor de servicios cierra el pedido

Documentación de referencia

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

Proveedor de servicios WeChat número de orden de pago orden de consulta

Documentación de referencia

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

Pedido de consulta del número de pedido del comerciante del proveedor de servicios

Documentación de referencia

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

Solicitud de reembolso del proveedor de servicios

Documentación de referencia

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

Proveedor de servicios pregunta sobre un reembolso único

Documentación de referencia

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

Notificación del resultado del reembolso del proveedor de servicios

Documentación de referencia

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

Factura electrónica del proveedor de servicios.

El proveedor de servicios crea una plantilla de factura, tarjeta y cupón electrónica

Documentación de referencia

 createCardTemplateOfPartner (datos: CreateCardTemplateRequestOfPartner, spMchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Opciones de desarrollo de configuración del proveedor de servicios

Documentación de referencia

 fapiaoDevConfigOfPartner (datos: DevelopmentConfigRequestOfPartner, spMchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

El proveedor de servicios consulta las opciones de desarrollo configuradas por el comerciante

Documentación de referencia

 getFapiaoDevConfigOfPartner (spMchId: cadena, subMchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Notificación de factura WeChat del proveedor de servicios

Documentación de referencia

 fapiaoCallbackOfPartner (certificados: Mapa<cadena, cadena>, apiKey: cadena, req: Solicitud, res: Respuesta): Promesa<FapiaoNotifyResultOfPartner>;

El proveedor del servicio obtiene el encabezado rellenado por el usuario.

Documentación de referencia

 getUserTitleOfPartner (parámetros: GetUserTitleParams, spMchId: cadena, subMchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Proveedor de servicios emite factura electrónica

Documentación de referencia

 issuesFapiaoOfPartner (datos: IssueFapiaoRequestOfPartner, spMchId: cadena, serialNo: cadena, privateKey: Buffer | cadena, platformSerial: cadena);

Consulta de proveedor de servicios factura electrónica

Documentación de referencia

 getIssueFapiaoOfPartner (fapiaoApplyId: cadena, fapiaoId: cadena | nulo | indefinido, spMchId: cadena, subMchid: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Proveedores de servicios facturas electrónicas rojas

Documentación de referencia

 reverseFapiaoOfPartner (fapiaoApplyId: cadena, datos: ReverseFapiaoRequestOfPartner, spMchId: cadena, serialNo: cadena, privateKey: Buffer | cadena);

Función de herramienta de pago WeChat

Descifrado de mensajes

descifrarTextocifrado

 decryptCipherText<T> (apiKey: cadena, cifrado: cadena, datos asociados: cadena, nonce: cadena): T |

Documentación de referencia

Herramientas de cifrado, descifrado y firma de mensajes de WeChat

 importar {MensajeCrypto} de 'nest-wechat';const sha1 = MessageCrypto.sha1('cadena a hash');

Método estático:

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

• md5 (texto: cadena): cadena;

• getAESKey (codificaciónAESKey: cadena): Búfer;

• getAESKeyIV (aesKey: Búfer): Búfer;

• PKCS7Encoder (buff: Búfer): Búfer;

• PKCS7Decoder (buff: Búfer): Búfer;

• descifrar (aesKey: Buffer, iv: Buffer, str: cadena): cadena;

• cifrar (aesKey: búfer, iv: búfer, mensaje: cadena, appId: cadena): cadena;

• createNonceStr (longitud = 16): cadena;

• encryptMessage (appId: cadena, token: cadena, codificaciónAESKey: cadena, mensaje: cadena, marca de tiempo: cadena, nonce: cadena): cadena;

• decryptMessage (token: cadena, codificaciónAESKey: cadena, firma: cadena, marca de tiempo: cadena, nonce: cadena, encryptXml: cadena);

• decryptMessage (token: cadena, codificaciónAESKey: cadena, firma: cadena, marca de tiempo: cadena, nonce: cadena, encryptXml: cadena);

• checkSignature (firma: cadena, marca de tiempo: cadena, nonce: cadena, token: cadena);

Ejecutar prueba

Cree el archivo .env.test.local y guarde su aplicación de prueba y su secreto en el archivo.

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

Ejecute la prueba e2e.

 prueba de ejecución de npm: e2e

Ejecute la prueba unitaria.

 npm ejecuta la prueba wechat.service.userinfo.spec.ts

Prueba de envío de mensajes

• Iniciar pruebas de servicio

 npx ts-nodo -T pruebas/e2e/wechat-app.main.ts

• Configuración de envío de mensajes de cuenta pública (plataforma de prueba pública WeChat), después de activar la prueba de servicio anterior, puede pasar la verificación de configuración

• URL: http://tu/url/wechat/push, como por ejemplo: http://113.22.11.2:3001/wechat/push

• Token: prueba de pam

• Obtenga access_token de la herramienta de depuración de la interfaz de la plataforma pública WeChat

cuerpo

 { "grant_type": "credencial_cliente",
"appid": "tu/appid",
"secreto": "tu/secreto",
"force_refresh": falso}

• Herramientas de depuración en la plataforma abierta WeChat: herramientas de depuración para pruebas de envío de mensajes para probar el envío