apihub-cdc/finacial-index-profile

本包最新版本(1.0.0)没有提供许可证信息。

1.0.0 2020-03-23 18:26 UTC

This package is auto-updated.

Last update: 2024-09-09 07:14:10 UTC


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

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

步骤 4. 修改 URL

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

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

步骤 5. 捕获请求数据

重要:需要有一个 setUp() 方法负责签名和验证请求。

class FipApiTest extends \PHPUnit_Framework_TestCase
{
    public function setUp()
    {
        $password = getenv('KEY_PASSWORD');
        $this->signer = new \FinacialIndexProfile\Client\Interceptor\KeyHandler(
            "/example/route/keypair.p12",
            "/example/route/cdc_cert_dev.pem",
            $password
        );
        $config = new \FinacialIndexProfile\Client\Configuration();
        $config->setHost('the_url');

        $events = new \FinacialIndexProfile\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'));

        $client = new \GuzzleHttp\Client(['handler' => $handler]);
        $this->apiInstance = new \FinacialIndexProfile\Client\Api\FipApi($client, $config);
        $this->x_api_key = "your_api_key";
        $this->username = "your_username";
        $this->password = "your_password";
    }
    
    public function testMadurez()
    {
        $folioConsulta = "10000000";
        try {
            $result = $this->apiInstance->madurez($this->x_api_key, $this->username, $this->password, $folioConsulta);
            print_r($result);
            $this->assertTrue($result->getFolioScore()!==null);
        } catch (Exception $e) {
            echo 'Exception when calling MadurezSimulacionApi->getReporte: ', $e->getMessage(), PHP_EOL;
        }
    }
}

单元测试

要执行单元测试

./vendor/bin/phpunit