undostres-com-mx / rcc-ficoscore-client-php
v2.0.5
2023-03-01 20:32 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- apihub-cdc/signature-manager: ^1.0
- guzzlehttp/guzzle: ^6.2
- monolog/monolog: ^1.24
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-09-30 00:15:19 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 安装说明
安装
执行: 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. 在开发者门户中加载证书
步骤 3. 在开发者门户中下载信用圈证书
非常重要,此容器应存储在以下路径:/path/to/repository/lib/Interceptor/keypair.p12
同样,信用圈提供的证书也应存储在以下路径:/path/to/repository/lib/Interceptor/cdc_cert.pem
- 如果未按照这种方式存储,则需要指定容器和证书的路径。请参考以下示例
$password = getenv('KEY_PASSWORD'); $this->signer = new \RCCFicoScore\Client\Interceptor\KeyHandler( "/example/route/keypair.p12", "/example/route/cdc_cert.pem", $password );
注意:仅在容器加密的情况下,需要在环境变量中设置密码并指定其名称,如上图所示。
步骤 4. 修改 URL
在 test/Api/ApiTest.php 的第 30 行修改请求的 URL,如下代码片段所示
$config = new \RCCFicoScore\Client\Configuration(); $config->setHost('the_url');
步骤 5. 捕获请求数据
需要有一个 setUp() 方法来负责签名和验证请求。
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 RCCFicoScoreApi($client, $config); $this->x_api_key = "your_api_key"; $this->username = "your_username"; $this->password = "your_password"; } public function testGetReporte() { $estado = new CatalogoEstados(); $request = new PersonaPeticion(); $domicilio = new DomicilioPeticion(); $request->setApellidoPaterno("PATERNO"); $request->setApellidoMaterno("MATERNO"); $request->setApellidoAdicional(null); $request->setPrimerNombre("PRIMERNOMBRE"); $request->setSegundoNombre(null); $request->setFechaNacimiento("1952-05-13"); $request->setRfc("PAMP010101"); $request->setCurp(null); $request->setNacionalidad(null); $request->setResidencia(null); $request->setEstadoCivil(null); $request->setSexo(null); $request->setClaveElectorIfe(null); $request->setNumeroDependientes(null); $request->setFechaDefuncion(null); $domicilio->setDireccion("HIDALGO 32"); $domicilio->setColoniaPoblacion(null); $domicilio->setDelegacionMunicipio("LA BARCA"); $domicilio->setCiudad("BENITO JUAREZ"); $domicilio->setEstado($estado::JAL); $domicilio->setCp("44190"); $domicilio->setFechaResidencia(null); $domicilio->setNumeroTelefono(null); $domicilio->setTipoDomicilio(null); $domicilio->setTipoAsentamiento(null); $request->setDomicilio($domicilio); try { $result = $this->apiInstance->getReporte($this->x_api_key, $this->username, $this->password, $request); $this->signer->close(); print_r($result); $this->assertTrue($result->getFolioConsulta()!==null); return $result->getFolioConsulta(); } catch (ApiException $e) { echo 'Exception when calling RCCFicoScoreApi->getReporte: ', $e->getMessage(), PHP_EOL; } }
单元测试
要执行单元测试
./vendor/bin/phpunit