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 如何安装

安装

运行: 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 \PLDNaturales\Client\Interceptor\KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
);

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

步骤 4. 捕获请求数据

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

重要：需要有一个 setUp()，它将负责初始化 URL、签名和验证请求。修改 $config 对象的请求 URL，如下代码片段所示

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

    $events = new \PLDNaturales\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 \PLDNaturales\Client\Configuration();
    $config->setHost('the_url');
    
    $this->apiInstance = new \PLDNaturales\Client\Api\PLDNaturalesApi($client,$config);
}    

<?php
/**
* Este es el método que se será ejecutado en la prueba ubicado en path/to/repository/test/Api/ApiTest.php 

*/
public function testPldNaturales()
{
    $x_api_key = "your_api_key";
    $username = "your_username";
    $password = "your_password";

    $request = new \PLDNaturales\Client\Model\Peticion();
    
    $request->setFolio("123456789");
    $request->setTipoDocumento("1");
    $request->setNumeroDocumento("00000088");
    $request->setNombre("NOMBRE");
    $request->setSegundoNombre("SEGUNDONOMBRE");
    $request->setApellidoPaterno("PATERNO");
    $request->setApellidoMaterno("MATERNO");

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

单元测试

要执行单元测试

./vendor/bin/phpunit