apihub-cdc/eflow-client-php

1.0.0 2020-02-24 21:31 UTC

This package is auto-updated.

Last update: 2024-09-10 03:31:49 UTC


README

这是一个为个人提供即时收入解决方案的产品。

要求

PHP 7.1 或更高版本

附加依赖

  • 需要以下 PHP 依赖项
    • ext-curl
    • ext-mbstring
  • 如果不符合,请在 Linux 上使用以下命令
#ejemplo con php en versión 7.3 para otra versión colocar php{version}-curl
apt-get install php7.3-curl
apt-get install php7.3-mbstring

安装

运行: composer install

入门指南

步骤 1. 生成密钥和证书

  • 需要有一个 PKCS12 格式的容器。
  • 如果没有,请执行 lib/Interceptor/key_pair_gen.sh 内的说明或以下命令。
  • 可选:为了加密容器,请将密码放在一个环境变量中。
export KEY_PASSWORD=your_password
  • 定义文件名和别名。
export PRIVATE_KEY_FILE=pri_key.pem
export CERTIFICATE_FILE=certificate.pem
export SUBJECT=/C=MX/ST=MX/L=MX/O=CDC/CN=CDC
export PKCS12_FILE=keypair.p12
export ALIAS=circulo_de_credito
  • 生成密钥和证书。
#Genera la llave privada.
openssl ecparam -name secp384r1 -genkey -out ${PRIVATE_KEY_FILE}

#Genera el certificado público.
openssl req -new -x509 -days 365 \
    -key ${PRIVATE_KEY_FILE} \
    -out ${CERTIFICATE_FILE} \
    -subj "${SUBJECT}"
  • 生成 PKCS12 格式的容器。
# Genera el archivo pkcs12 a partir de la llave privada y el certificado.
# Deberá empaquetar la llave privada y el certificado.
openssl pkcs12 -name ${ALIAS} \
    -export -out ${PKCS12_FILE} \
    -inkey ${PRIVATE_KEY_FILE} \
    -in ${CERTIFICATE_FILE} -password pass:${KEY_PASSWORD}

步骤 2. 在开发者门户中加载证书

  1. 登录。
  2. 点击 "我的应用" 部分。
  3. 选择应用程序。
  4. 转到 "为 @tuApp 的证书" 选项卡。

  5. 在弹出的窗口中,选择之前创建的证书并点击 "加载" 按钮

步骤 3. 在开发者门户中下载信用循环证书

  1. 登录。
  2. 点击 "我的应用" 部分。
  3. 选择应用程序。
  4. 转到 "为 @tuApp 的证书" 选项卡。

  5. 在弹出的窗口中,点击 "下载" 按钮

请确保将此容器存储在以下路径: /path/to/repository/lib/Interceptor/keypair.p12

同样,信用循环提供的证书在以下路径: /path/to/repository/lib/Interceptor/cdc_cert.pem

  • 如果未存储在上述路径,则必须指定容器和证书的路径。请参阅以下示例
/**
* Esto es parte del setUp() de las pruebas unitarias.
*/
$password = getenv('KEY_PASSWORD');
$this->signer = new \EFLOW\Client\Interceptor\KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
);

注意: 仅在容器已加密的情况下,才需要在环境变量中放置密码并指定其名称,如上图所示。

步骤 4. 捕获请求数据

以下需要修改的数据位于 test/Api/ApiTest.php

需要有一个 setUp(),它负责初始化 URL、签名和验证请求。修改 $config 对象的请求 URL,如下所示

public function setUp()
{
    $password = getenv('KEY_PASSWORD');
    $this->signer = new \EFLOW\Client\Interceptor\KeyHandler(null, null, $password);     

    $events = new \EFLOW\Client\Interceptor\MiddlewareEvents($this->signer);
    $handler = \GuzzleHttp\HandlerStack::create();
    $handler->push($events->add_signature_header('x-signature'));
    $handler->push($events->verify_signature_header('x-signature'));

    $client = new \GuzzleHttp\Client(['handler' => $handler, 'verify' => false]);
    $config = new \EFLOW\Client\Configuration();
    $config->setHost('the_url');
    
    $this->apiInstance = new \EFLOW\Client\Api\EFLOWApi($client,$config);
} 
/**
* Este es el método que se será ejecutado en la prueba ubicado en path/to/repository/test/Api/ApiTest.php 
*/
public function testEflow()
{
    $x_api_key = "your_api_key";
    $username = "your_username";
    $password = "your_password";

    $request = new \EFLOW\Client\Model\Peticion();

    $request->setFolio("000016");
    $request->setTipoDocumento("1");
    $request->setNumeroDocumento("00000002");

    try {
        $result = $this->apiInstance->eflow($x_api_key, $username, $password, $request);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling ApiTest->eflow: ', $e->getMessage(), PHP_EOL;
    }
}

单元测试

要执行单元测试

./vendor/bin/phpunit