README

这是墨西哥市场上第一个使用Circle Credit独家算法评估个人支付履约水平的评分。

要求

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. 在开发者门户中下载Circle Credit证书

1. 登录。
2. 点击 "我的应用" 部分。
3. 选择应用程序。
4. 转到 "为 @tuApp 的证书" 选项卡。

   

5. 在弹出窗口中，点击 "下载" 按钮

   

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

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

• 如果未存储在此路径，则必须指定容器和证书的存储路径。请参阅以下示例

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

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

步骤 4. 修改URL

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

$config = new \FicoEXTScored\Client\Configuration();
$config->setHost('the_url');

步骤 5. 捕获请求数据

需要具有 setUp()，该函数将负责签名和验证请求。

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

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

    $config = new \FicoEXTScored\Client\Configuration();
    $config->setHost('the_url');

    $this->apiInstance = new \FicoEXTScored\Client\Api\FicoEXTScoredApi($client, $config);
    $this->x_api_key = "your_api_key";
    $this->username = "your_username";
    $this->password = "your_password";
}
    
public function testGetReporte(){

    $request = new \FicoEXTScored\Client\Model\Peticion();
    $persona = new \FicoEXTScored\Client\Model\Persona();
    $domicilio = new \FicoEXTScored\Client\Model\Domicilio();        
    $estado = new \FicoEXTScored\Client\Model\CatalogoEstados();
        
    $domicilio->setDireccion("CALVARIO");
    $domicilio->setColoniaPoblacion("LOMA DE LA PALMA");
    $domicilio->setDelegacionMunicipio("GUSTAVO A  MADERO");
    $domicilio->setCiudad("CIUDAD DE MEXICO");
    $domicilio->setEstado($estado::DF);
    $domicilio->setCP("07160");
    $domicilio->setFechaResidencia(null);
    $domicilio->setNumeroTelefono(null);
    $domicilio->setTipoDomicilio(null);
    $domicilio->setTipoAsentamiento(null);
    $domicilio->setFechaRegistroDomicilio(null);
    $domicilio->setTipoAltaDomicilio(null);
    $domicilio->setIdDomicilio(null);

    $persona->setApellidoPaterno("PATERNO");
    $persona->setApellidoMaterno("MATERNO");
    $persona->setApellidoAdicional(null);
    $persona->setNombres("NOMBRES");
    $persona->setFechaNacimiento("YYYY-MM-DD");
    $persona->setRFC("PAMN800825569");
    $persona->setCURP(null);
    $persona->setNacionalidad("MX");
    $persona->setResidencia(null);
    $persona->setEstadoCivil(null);
    $persona->setSexo(null);
    $persona->setNumeroDependientes(null);
    $persona->setFechaDefuncion(null);
    $persona->setDomicilio($domicilio);
     
    $request->setFolio("1235");
    $request->setPersona($persona);        

    try {
        $result = $this->apiInstance->getReporte($this->x_api_key, $this->username, $this->password, $request);
        print_r($result);
        $this->assertTrue($result->getFolioConsulta()!==null);

        return $result->getFolioConsulta();
    } catch (Exception $e) {
        echo 'Exception when calling FicoEXTScoredApi->getReporte: ', $e->getMessage(), PHP_EOL;
    }
}

单元测试

要执行单元测试

./vendor/bin/phpunit