README

此API提供信用历史报告，记录个人与金融机构、非金融机构和商业机构签订的承诺的支付履行情况。

要求

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. 转到“Certificados para @tuApp”选项卡。

   

5. 在弹出窗口中，选择之前创建的证书并点击“Cargar”按钮

   

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

1. 登录。
2. 点击“我的应用”部分。
3. 选择应用程序。
4. 转到“Certificados para @tuApp”选项卡。

   

5. 在弹出窗口中，点击“Descargar”按钮

   

非常重要，请将此容器存储在以下路径：/path/to/repository/lib/Interceptor/keypair.p12

同样，信用圈提供的证书存储在以下路径：/path/to/repository/lib/Interceptor/cdc_cert.pem

• 如果未按照这种方式存储，请指定容器和证书的路径。请参阅以下示例

$password = getenv('KEY_PASSWORD');
$this->signer = new \RcClientPhp\Client\Interceptor\KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
);

注意：仅当容器加密时，才需要在环境变量中放置密码并指定其名称，如上图所示。

步骤 4. 修改 URL

在 lib/Configuration.php 中修改第19行的请求URL，如下代码片段所示

protected $host = 'the_url';

步骤 5. 捕获请求数据

需要有一个setUp()，它负责签名和验证请求。

<?php
public function setUp()
{
    $config = new \RcClientPhp\Client\Configuration();
    $config->setHost('the_url');
    $password = getenv('KEY_PASSWORD');
    $this->signer = new \RcClientPhp\Client\Interceptor\KeyHandler(null, null, $password);
    $events = new \RcClientPhp\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]);
    $this->apiInstance = new \RcClientPhp\Client\Api\ReporteDeCrditoApi($client, $config);
    $this->x_api_key = "your_api_key";
    $this->username = "your_username";
    $this->password = "your_password";
}    

<?php

public function testGetReporte()
    {


        $request = new \RcClientPhp\Client\Model\PersonaPeticion();
        $request->setPrimerNombre("XXXX");
        $request->setApellidoPaterno("XXXX");
        $request->setApellidoMaterno("XXXXX");
        $request->setFechaNacimiento("yyyy-mm-dd");
        $request->setRfc("XXXXXX");
        $request->setNacionalidad("XX");
        $dom = new \RcClientPhp\Client\Model\DomicilioPeticion();
        $dom->setDireccion("XXXXXX");
        $dom->setColoniaPoblacion("XXXXXX");
        $dom->setDelegacionMunicipio("XXXXX");
        $dom->setCiudad("XXXXXXXX");
        $dom->setEstado("XXX");
        $dom->setCP("XXXXX");
        $dom->setFechaResidencia("yyyy-mm-dd");
        $dom->setNumeroTelefono("XXXXXXX");
        $dom->setTipoDomicilio("X");
        $dom->setTipoAsentamiento("XX");

        $request->setDomicilio($dom);

        try {
            $result = $this->apiInstance->getReporte($this->x_api_key, $this->username, $this->password, $request);
            $this->assertTrue($result->getFolioConsulta()!==null);
            echo "testGetReporte finished\n";
            return $result->getFolioConsulta();
        } catch (Exception $e) {
            echo 'Exception when calling ReporteDeCrditoApi->getReporte: ', $e->getMessage(), PHP_EOL;
        }
    }
?>

单元测试

要执行单元测试

./vendor/bin/phpunit