Descarga wechatpay guzzle middleware - descarga de código fuente wechatpay guzzle middleware

wechatpay-guzzle-middleware

Descripción general

El middleware Guzzle HttpClient de WeChat Payment API v3 implementa la generación de firmas de solicitud y la verificación de firmas de respuesta.

Si es un desarrollador comercial que utiliza Guzzle, puede pasar WechatPayGuzzleMiddleware al construir GuzzleHttpClient . La instancia GuzzleHttpClient resultante llevará automáticamente información de autenticación de identidad al ejecutar una solicitud y verificará la firma de WeChat Pay de la respuesta.

Estado del proyecto

La versión actual es la versión de prueba 0.2.0 . Preste atención a la corrección y compatibilidad del sistema y el software, así como a los riesgos involucrados, cuando utilice el personal técnico y profesional del comerciante.

Este proyecto está en mantenimiento . Recomendamos que todos los desarrolladores den prioridad al uso de la nueva biblioteca de desarrollo PHP de WeChat Pay, wechatpay-php.

Requisitos medioambientales

El entorno que utilizamos para el desarrollo y las pruebas es el siguiente:

PHP 5.5+/PHP 7.0+
tragohttp/trago ^6.3

Nota: La razón específica por la que guzzle7 no es compatible se puede encontrar en la discusión del n.° 54. Los desarrolladores que confían en guzzle7 utilizan wechatpay-php.

Instalar

Puede utilizar el compositor de la herramienta de administración de paquetes PHP para introducir el SDK en el proyecto:

Compositor

Método 1: en el directorio del proyecto, agregue a través de la línea de comando del compositor:

composer require wechatpay/wechatpay-guzzle-middleware

Método 2: agregue la siguiente configuración al compositor.json del proyecto:

    "require" : {
        "wechatpay/wechatpay-guzzle-middleware" : " ^0.2.0 "
    }

Después de agregar la configuración, realice la instalación.

composer install

comenzar

Primero, cree un WechatPayMiddleware a través de WechatPayMiddlewareBuilder y luego agréguelo al HandlerStack de GuzzleHttpClient . Proporcionamos los métodos correspondientes para transferir cómodamente información como claves privadas de comerciantes y certificados de la plataforma de pago WeChat.

 use GuzzleHttp  Exception  RequestException ;
use WechatPay  GuzzleMiddleware  WechatPayMiddleware ;
use WechatPay  GuzzleMiddleware  Util  PemUtil ;

// 商户相关配置
$ merchantId = ' 1000100 ' ; // 商户号
$ merchantSerialNumber = ' XXXXXXXXXX ' ; // 商户API证书序列号
$ merchantPrivateKey = PemUtil:: loadPrivateKey ( ' /path/to/mch/private/key.pem ' ); // 商户私钥
// 微信支付平台配置
$ wechatpayCertificate = PemUtil:: loadCertificate ( ' /path/to/wechatpay/cert.pem ' ); // 微信支付平台证书

// 构造一个WechatPayMiddleware
$ wechatpayMiddleware = WechatPayMiddleware:: builder ()
    -> withMerchant ( $ merchantId , $ merchantSerialNumber , $ merchantPrivateKey ) // 传入商户相关配置
    -> withWechatPay ([ $ wechatpayCertificate ]) // 可传入多个微信支付平台证书，参数类型为array
    -> build ();

// 将WechatPayMiddleware添加到Guzzle的HandlerStack中
$ stack = GuzzleHttp HandlerStack:: create ();
$ stack -> push ( $ wechatpayMiddleware , ' wechatpay ' );

// 创建Guzzle HTTP Client时，将HandlerStack传入
$ client = new GuzzleHttp  Client ([ ' handler ' => $ stack ]);


// 接下来，正常使用Guzzle发起API请求，WechatPayMiddleware会自动地处理签名和验签
try {
    $ resp = $ client -> request ( ' GET ' , ' https://api.mch.weixin.qq.com/v3/... ' , [ // 注意替换为实际URL
        ' headers ' => [ ' Accept ' => ' application/json ' ]
    ]);

    echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
    echo $ resp -> getBody (). "n" ;

    $ resp = $ client -> request ( ' POST ' , ' https://api.mch.weixin.qq.com/v3/... ' , [
        ' json ' => [ // JSON请求体
            ' field1 ' => ' value1 ' ,
            ' field2 ' => ' value2 '
        ],
        ' headers ' => [ ' Accept ' => ' application/json ' ]
    ]);

    echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
    echo $ resp -> getBody (). "n" ;
} catch ( RequestException $ e ) {
    // 进行错误处理
    echo $ e -> getMessage (). "n" ;
    if ( $ e -> hasResponse ()) {
        echo $ e -> getResponse ()-> getStatusCode (). ' ' . $ e -> getResponse ()-> getReasonPhrase (). "n" ;
        echo $ e -> getResponse ()-> getBody ();
    }
    return ;
}

Subir archivos multimedia

 // 参考上述指引说明，并引入 `MediaUtil` 正常初始化，无额外条件
use WechatPay  GuzzleMiddleware  Util  MediaUtil ;
// 实例化一个媒体文件流，注意文件后缀名需符合接口要求
$ media = new MediaUtil ( ' /your/file/path/with.extension ' );

// 正常使用Guzzle发起API请求
try {
    $ resp = $ client -> request ( ' POST ' , ' https://api.mch.weixin.qq.com/v3/[merchant/media/video_upload|marketing/favor/media/image-upload] ' , [
        ' body '    => $ media -> getStream (),
        ' headers ' => [
            ' Accept '       => ' application/json ' ,
            ' content-type ' => $ media -> getContentType (),
        ]
    ]);
    // POST 语法糖
    $ resp = $ client -> post ( ' merchant/media/upload ' , [
        ' body '    => $ media -> getStream (),
        ' headers ' => [
            ' Accept '       => ' application/json ' ,
            ' content-type ' => $ media -> getContentType (),
        ]
    ]);
    echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
    echo $ resp -> getBody (). "n" ;
} catch ( Exception $ e ) {
    echo $ e -> getMessage (). "n" ;
    if ( $ e -> hasResponse ()) {
        echo $ e -> getResponse ()-> getStatusCode (). ' ' . $ e -> getResponse ()-> getReasonPhrase (). "n" ;
        echo $ e -> getResponse ()-> getBody ();
    }
    return ;
}

Cifrado/descifrado de información confidencial

 // 参考上上述说明，引入 `SensitiveInfoCrypto`
use WechatPay  GuzzleMiddleware  Util  SensitiveInfoCrypto ;
// 上行加密API 多于 下行解密，默认为加密，实例后直接当方法用即可
$ encryptor = new SensitiveInfoCrypto (PemUtil:: loadCertificate ( ' /path/to/wechatpay/cert.pem ' ));

// 正常使用Guzzle发起API请求
try {
    // POST 语法糖
    $ resp = $ client -> post ( ' /v3/applyment4sub/applyment/ ' , [
        ' json ' => [
            ' business_code ' => ' APL_98761234 ' ,
            ' contact_info '  => [
                ' contact_name '      => $ encryptor ( ' value of `contact_name` ' ),
                ' contact_id_number ' => $ encryptor ( ' value of `contact_id_number ' ),
                ' mobile_phone '      => $ encryptor ( ' value of `mobile_phone` ' ),
                ' contact_email '     => $ encryptor ( ' value of `contact_email` ' ),
            ],
            //...
        ],
        ' headers ' => [
            // 命令行获取证书序列号
            // openssl x509 -in /path/to/wechatpay/cert.pem -noout -serial | awk -F= '{print $2}'
            // 或者使用工具类获取证书序列号 `PemUtil::parseCertificateSerialNo($certificate)`
            ' Wechatpay-Serial ' => ' must be the serial number via the downloaded pem file of `/v3/certificates` ' ,
            ' Accept '           => ' application/json ' ,
        ],
    ]);
    echo $ resp -> getStatusCode (). ' ' . $ resp -> getReasonPhrase (). "n" ;
    echo $ resp -> getBody (). "n" ;
} catch ( Exception $ e ) {
    echo $ e -> getMessage (). "n" ;
    if ( $ e -> hasResponse ()) {
        echo $ e -> getResponse ()-> getStatusCode (). ' ' . $ e -> getResponse ()-> getReasonPhrase (). "n" ;
        echo $ e -> getResponse ()-> getBody ();
    }
    return ;
}

// 单例加解密示例如下
$ crypto = new SensitiveInfoCrypto ( $ wechatpayCertificate , $ merchantPrivateKey );
$ encrypted = $ crypto ( ' Alice ' );
$ decrypted = $ crypto -> setStage ( ' decrypt ' )( $ encrypted );

por encargo

Cuando los métodos de firma y verificación locales predeterminados no son adecuados para su sistema, puede personalizar la firma y la verificación implementando Signer o Verifier . Por ejemplo, si su sistema almacena de forma centralizada las claves privadas del comerciante y el sistema empresarial necesita realizar firmas a través de llamadas remotas, puede hacerlo.

 use WechatPay  GuzzleMiddleware  Auth  Signer ;
use WechatPay  GuzzleMiddleware  Auth  SignatureResult ;
use WechatPay  GuzzleMiddleware  Auth  WechatPay2Credentials ;

class CustomSigner implements Signer
{
    public function sign ( $ message )
    {
        // 调用签名RPC服务，然后返回包含签名和证书序列号的SignatureResult
        return new SignatureResult ( ' xxxx ' , ' yyyyy ' );
    }
}

$ credentials = new WechatPay2Credentials ( $ merchantId , new CustomSigner );

$ wechatpayMiddleware = WechatPayMiddleware:: builder ()
    -> withCredentials ( $ credentials )
    -> withWechatPay ([ $ wechatpayCertificate ])
    -> build ();

Preguntas frecuentes

¿Cómo descargar el certificado de la plataforma?

El uso de WechatPayMiddlewareBuilder requiere llamar withWechatpay para configurar el certificado de la plataforma de pago WeChat, y el certificado de la plataforma solo se puede descargar llamando a la API Obtener certificado de plataforma. Para romper el "bucle infinito", puede "omitir" temporalmente la verificación de la firma de respuesta al descargar el certificado de la plataforma por primera vez de la siguiente manera.

 use WechatPay  GuzzleMiddleware  Validator ;

class NoopValidator implements Validator
{
    public function validate (  Psr  Http  Message  ResponseInterface $ response )
    {
        return true ;
    }
}

$ wechatpayMiddleware = WechatPayMiddleware:: builder ()
    -> withMerchant ( $ merchantId , $ merchantSerialNumber , $ merchantPrivateKey )
    -> withValidator ( new NoopValidator ) // NOTE: 设置一个空的应答签名验证器，**不要**用在业务请求
    -> build ();

Nota : utilice el proceso de inicialización estándar para solicitudes comerciales y asegúrese de verificar la firma de la respuesta.

¿Dónde se requiere el descifrado AesGcm para el descifrado de certificados y devoluciones de llamada?

Consulte AesUtil.php.

Cuando se usa con swoole, la interfaz de carga de archivos informa un error.

Se recomienda actualizar a swoole 4.6+. Se agregó compatibilidad con curl nativo (swoole/swoole-src#3863) en 4.6.0. Para obtener información más detallada, consulte el punto 36.