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 \lae\Client\Interceptor\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()方法来负责签名和验证请求。以下代码片段是将在位于 test/Api/ApiTest.php 的测试中执行的方法。

注意：以下请求数据仅供参考。

    
public function testGetReporte()
{
    $domicilio = new \Telcos\MX\Client\Model\DomicilioPeticion();
    $CatalogoEstados = new \Telcos\MX\Client\Model\CatalogoEstados();
    $CatalogoTipoDomicilio = new \Telcos\MX\Client\Model\CatalogoTipoDomicilio();
    $requestTipoAsent = new \Telcos\MX\Client\Model\CatalogoTipoAsentamiento();

    $domicilio->setEstado($CatalogoEstados::CDMX);
    $domicilio->setTipoDomicilio($CatalogoTipoDomicilio::C);
    $domicilio->setTipoAsentamiento($requestTipoAsent::_1);

    $persona = new \Telcos\MX\Client\Model\PersonaPeticion();
    $CatalogoResidencia = new \Telcos\MX\Client\Model\CatalogoResidencia();
    $requestEdoCivil = new \Telcos\MX\Client\Model\CatalogoEstadoCivil();
    $requestSexo = new \Telcos\MX\Client\Model\CatalogoSexo();
    
    $persona->setPrimerNombre("NOMBRE");
    $persona->setSegundoNombre(null);
    $persona->setApellidoPaterno("PATERNO");
    $persona->setApellidoMaterno("MATERNO");
    $persona->setApellidoAdicional(null);
    $persona->setFechaNacimiento("1980-01-04");
    $persona->setResidencia($CatalogoResidencia::_1);
    $persona->setEstadoCivil($requestEdoCivil::S);
    $persona->setSexo($requestSexo::M);
    $persona->setDomicilio($domicilio);       

    $peticion = new \Telcos\MX\Client\Model\Peticion(); 

    $peticion->setFolioOtorgante("1234");
    $peticion->setPersona($persona);

    try {
        $result = $this->apiInstance->getReporte($this->x_api_key, $this->username, $this->password, $peticion);
        if($this->apiInstance->getStatusCode() == 200){
            print_r($result);
        }
    } catch (ApiException $e) {
        echo ' code. Exception when calling ApiTest->testGetReporte: ', $e->getResponseBody(), PHP_EOL;
    }
    $this->assertTrue($this->apiInstance->getStatusCode() == 200);        
}

单元测试

要执行单元测试

./vendor/bin/phpunit