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. 转到 "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 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 testGetReporteCreditoPM()
    {
        try {

            $request = new PersonaPeticion();
            $persona = new Persona();
            $domicilio = new PersonaDomicilio(); 
            $catalogoEstados = new CatalogoEstados(); 
            $catalogoPais = new CatalogoPais();            

            $domicilio->setDireccion("AV. PASEO DE LA REFORMA 01");
            $domicilio->setColoniaPoblacion("GUERRERO");
            $domicilio->setDelegacionMunicipio("CUAUHTEMOC");
            $domicilio->setCiudad("CIUDAD DE MÉXICO");
            $domicilio->setEstado($catalogoEstados::DF);
            $domicilio->setCP("68370");
            $domicilio->setPais($catalogoPais::MX);

            $persona->setRFC("EDC930121E01");
            $persona->setNombre("RESTAURANTE SA DE CV");
            $persona->setDomicilio($domicilio);

            $request->setFolioOtorgante("1000001");
            $request->setPersona($persona);

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

单元测试

要执行单元测试

./vendor/bin/phpunit

术语和条件