README

根据FICO Score模型的数据，提供金融评分。

要求

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 \APIHub\Client\Interceptor\KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
);

注意：仅在容器加密的情况下，请将密码存储在环境变量中，并指定如上图所示的环境变量名称。

步骤4. 修改URL

以下数据位于test/Api/FicoScoreApiTest.php中需要修改

负责初始化URL的setUp()。修改$conf对象请求的URL ('the_url')，如下代码片段所示

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

步骤5. 捕获请求数据

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

<?php
public function setUp()
  {
    $password = getenv('KEY_PASSWORD');
    $this->signer = new \FicoscorePeru\Client\Interceptor\KeyHandler(null, null, $password);
    $events = new \FicoscorePeru\Client\Interceptor\MiddlewareEvents($this->signer);
    $handler = \GuzzleHttp\HandlerStack::create();
    $handler->push($events->add_signature_header('x-signature'));
    $handler->push($events->verify_signature_header('x-signature'));
    $config = new \FicoscorePeru\Client\Configuration();
    $config->setHost('the_url');

    $client = new \GuzzleHttp\Client(['handler' => $handler]);
    $this->apiInstance = new \FicoscorePeru\Client\Api\FicoScoreApi($client, $config);
  }   

<?php

public function testFicoScoreApi()
  {
    $x_api_key = "your_api_key";
    $username = "your_username";
    $password = "your_password";

    $request = new \FicoscorePeru\Client\Model\DatosConsulta();

    $request->setNumeroDocumento('xxxxx');
    $request->setTipoDocumento('x');
    $request->setFolioConsultaOtorgante(null);

    try {
      $result = $this->apiInstance->ficoScore($x_api_key, $username, $password, $request);
        $this->assertNotNull($result);
      } catch (Exception $e) {
        echo 'Exception when calling FicoScoreApi->ficoScore: ', $e->getMessage(), PHP_EOL;
    }
  }
?>

单元测试

要执行单元测试

./vendor/bin/phpunit