README

可以调用以下API的项目

• 与FICO® Score和反洗钱预防相结合的信用报告 - RCC-FS-PLD - 查看此处
• 信用报告 - RCC - 查看此处
• FICO® Score - FS - 查看此处

要求

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/TOE/Api/ 中每个测试文件的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()，它将负责签名和验证请求。同样，使用要查询的数据构建请求。

注意：测试中的请求数据仅作示例。

单元测试

要执行单元测试

./vendor/bin/phpunit