apihub-cdc/vantage

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

1.0.1 2020-10-28 21:32 UTC

This package is auto-updated.

Last update: 2024-09-29 05:42:54 UTC


README

这是一个将欠款客户分为6个等级的模型,根据预期未来30天内欠款进展。通过细分人口来降低欠款管理成本。

要求

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

  • 如果没有按照这种方式存储,则必须指定容器和证书的路径。请参阅以下示例
/**
* Esto es parte del setUp() de las pruebas unitarias.
*/
$password = getenv('KEY_PASSWORD');
$this->signer = new KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
);

注意:仅在容器加密的情况下,才需要在环境变量中放置密码并指定其名称,如前面的图片所示。

步骤4. 修改URL

lib/Configuration.php中修改第19行的请求URL,如下所示

protected $host = 'the_url';

步骤5. 捕获请求数据

必须有一个setUp(),负责签名和验证请求。

<?php
public function setUp()
{
  $password = getenv('KEY_PASSWORD');
  $this->keypair = 'path/to/keypair.p12';
  $this->cert = 'path/to/certificate.pem';
  $this->url = 'this_url';

  $this->signer = new KeyHandler($this->keypair, $this->cert, $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($this->url);
  
  $this->apiInstance = new Instance($client, $config);
  $this->x_api_key = "your_api_key";
  $this->username = "your_username";
  $this->password = "your_password";
}

注意:以下请求数据仅作为示例。

<?php
public function testGetVantageAportantes(){
    try {
        $request = new AportantesPeticion();
        $tipoContrato = new CatalogoContrato();

        $request->setFolio("0000001");
        $request->setTipoContrato($tipoContrato::TC);
        $request->setNumeroCuenta("4772133042201399");
        $request->setDiasAtraso(1);
        $result = $this->apiInstance->getVantageAportantes($this->x_api_key, $this->username, $this->password, $request);

        if($this->apiInstance->getStatusCode() == 200){
            print_r($result);
        }
    } catch (ApiException $e) {

        if($e->getCode() !== 204){
            echo 'Exception when calling ApiTest->testGetVantageAportantes: ', $e->getMessage(), PHP_EOL;
        }
    }
    $this->assertTrue($this->apiInstance->getStatusCode() == 200);        
}

public function testGetVantageNoAportantes(){
    try {
        $tipoContrato = new CatalogoContrato();
        $catalogoPago = new CatalogoFrecuenciaPago();
        $persona = new PersonaPeticion();
        $domicilio = new DomicilioPeticion();
        $catalogoEstados = new CatalogoEstados();
        $request = new NoAportantesPeticion();
        
        $domicilio->setDireccion("INSURGENTES SUR 1007");
        $domicilio->setColoniaPoblacion("INSURGENTES");
        $domicilio->setDelegacionMunicipio("BENITO JUAREZ");
        $domicilio->setCiudad("CIUDAD DE MÉXICO");
        $domicilio->setEstado($catalogoEstados::DF);
        $domicilio->setCp("11230");

        $persona->setPrimerNombre("JUAN");
        $persona->setApellidoPaterno("PRUEBA");
        $persona->setApellidoMaterno("SIETE");
        $persona->setFechaNacimiento("1980-01-07");
        $persona->setDomicilio($domicilio);

        $request->setFolio("0000002");
        $request->setTipoProducto("O");
        $request->setTipoContrato($tipoContrato::TC);
        $request->setFrecuenciaPago($catalogoPago::M);
        $request->setDiasAtraso(1);
        $request->setNumeroCuenta("123456");
        $request->setFechaApertura("1990-10-19");
        $request->setSaldoActual(15301);
        $request->setPersona($persona);

        $result = $this->apiInstance->getVantageNoAportantes($this->x_api_key, $this->username, $this->password, $request);

        if($this->apiInstance->getStatusCode() == 200){
            print_r($result);
        }
    } catch (ApiException $e) {

        if($e->getCode() !== 204){
            echo 'Exception when calling ApiTest->testGetVantageNoAportantes: ', $e->getMessage(), PHP_EOL;
        }
    }
    $this->assertTrue($this->apiInstance->getStatusCode() == 200);         
}
?>

单元测试

要执行单元测试

./vendor/bin/phpunit