README

账户余额向量返回特定人的账户余额向量。信息按月提供，包括前12个月以及当前月份的数据，包括应付款项和当前及逾期余额。

要求

PHP 7.1 或更高版本

额外依赖

• 以下PHP依赖项是必需的
  • ext-curl
  • ext-mbstring
• 安装示例（Linux）

apt-get install php7.3-curl
apt-get install php7.3-mbstring

• Composer 如何安装

安装

composer install

入门指南

步骤 1. 生成密钥和证书

• 需要有一个PKCS12格式的容器；如果没有，则执行脚本 lib/Interceptor/key_pair_gen.sh 或执行以下步骤

# Definición de nombres de archivos y alias.
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
# Opcionalmente, para cifrar el contenedor, colocar una contraseña en una variable de ambiente.
export KEY_PASSWORD=your_password
#Generación de llave privada.
openssl ecparam -name secp384r1 -genkey -out ${PRIVATE_KEY_FILE}
#Generación de certificado público.
openssl req -new -x509 -days 365 \
    -key ${PRIVATE_KEY_FILE} \
    -out ${CERTIFICATE_FILE} \
    -subj "${SUBJECT}"
# Generación de archivo pkcs12 a partir de llave privada y certificado.
# Se 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 \VectoresSaldos\Client\Interceptor\KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
  );

注意：仅当容器被加密时，才需要将密码放置在环境变量中，并指明该变量的名称。

步骤 4. 捕获请求数据

以下需要修改的数据位于 test/Api/VectoresSaldosApiTest.php

重要的是要有一个setUp()，它会负责初始化URL、签名和验证请求。修改对象 $config 的请求URL，如下面的代码片段所示

  public function setUp()
  {
      $password = getenv('KEY_PASSWORD');
      $this->signer = new \VectoresSaldos\Client\Interceptor\KeyHandler(null, null, $password);
      $events = new \VectoresSaldos\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,
          'verify' => false
      ]);

      $config = new \VectoresSaldos\Client\Configuration();
      $config->setHost('the_url');
      
      $this->apiInstance = new \VectoresSaldos\Client\Api\VectoresSaldosApi($client);
  }

public function testGetVectorSaldos()
{
    $x_api_key = "your_api_key";
    $username = "your_username";
    $password = "your_password";
    $body = new \VectoresSaldos\Client\Model\Persona();
    $body->setPrimerNombre("XXXXX");
    $body->setSegundoNombre("XXXXX");
    $body->setApellidoPaterno("XXXXX");
    $body->setApellidoMaterno("XXXXX");
    $body->setApellidoAdicional("XXXXX");
    $body->setFechaNacimiento("YYY-MM-DD");
    $body->setRfc("XXXXX");
    $body->setCurp("XXXXX");
    $domicilio = new \VectoresSaldos\Client\Model\Domicilio();
    $domicilio->setDireccion("XXXXX");
    $domicilio->setColonia("XXXXX");
    $domicilio->setCiudad("XXXXX");
    $domicilio->setCodigoPostal("XXXXX");
    $domicilio->setMunicipio("XXXXX");
    $domicilio->setEstado("XXXX");
    $body->setDomicilio($domicilio);
    try {
        $result = $this->apiInstance->getVectorSaldos($x_api_key, $username, $password, $body);
        $this->signer->close();
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling VectoresSaldosApi->getVectorSaldos: ', $e->getMessage(), PHP_EOL;
    }
}
?>

单元测试

• 要执行单元测试

./vendor/bin/phpunit