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

• 如果存储路径不同，请指定容器和证书的路径。查看以下示例

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

注意：仅当容器加密时，才需要在环境变量中设置密码并指明变量名，如前图所示。

步骤 4. 修改 URL 和凭据

在 test/Api/ApiTest.php 中修改访问请求的 URL 和凭据，如下代码片段所示

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

    $events = new MiddlewareEvents($this->signer);
    $handler = handlerStack::create();
    $handler->push($events->add_signature_header('x-signature'));   
    $handler->push($events->verify_signature_header('x-signature'));
    $client = new Client(['handler' => $handler]);

    $config = new Configuration();
    $config->setHost('the_url');
    
    $this->apiInstance = new Instance($client, $config);
    $this->x_api_key = "your_api_key";
    $this->username = "your_username";
    $this->password = "your_password";
}   

步骤 5. 捕获请求数据

需要 setUp() 函数来签名和验证请求。

注意：以下请求数据仅作示例。

public function testGetReporte(){
   

    $estado = new CatalogoEstados();
    $request = new PersonaPeticion();

    $request->setPrimerNombre("JUAN");
    $request->setApellidoPaterno("PRUEBA");
    $request->setApellidoMaterno("SIETE");
    $request->setFechaNacimiento("1980-01-07");
    $request->setRfc("PUAC800107");
    $request->setNacionalidad("MX");

    $dom = new DomicilioPeticion();
    $dom->setDireccion("INSURGENTES SUR 1001");
    $dom->setColoniaPoblacion("INSURGENTES SUR");
    $dom->setDelegacionMunicipio("CIUDAD DE MEXICO");
    $dom->setCiudad("CIUDAD DE MEXICO");
    $dom->setEstado($estado::DF);
    $dom->setCP("11230");

    $request->setDomicilio($dom);

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

单元测试

要执行单元测试

./vendor/bin/phpunit

使用条件、复制和分发