apihub-cdc / fintechscore-client-php
dev-release/1.0.0
2021-05-13 17:17 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- apihub-cdc/signature-manager: ^1.0.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-29 02:03:27 UTC
README
La API FinTech Score 是一种工具,您可以根据申请人的风险水平对申请人进行排序,满足 FinTech 的需求,如:平均 1 天到 3 个月的较短期限,平均 3.5K 美元的金额,更频繁的续约,更高的利率和即时可用性。
要求
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 KeyHandler( "/example/route/keypair.p12", "/example/route/cdc_cert.pem", $password );
注意: 仅当容器被加密时,才需要在环境变量中放置密码并指示其名称,如上图所示。
步骤 4. 修改 URL 和凭证
在 test/Api/FintechScoreApiTest.php 中修改请求的 URL 和凭证,如下代码片段所示
public function setUp() { $password = 'KEY_PASSWORD'; $this->keypair = 'path/keypair.p12'; $this->cert = 'path/cdc_cert.pem'; $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('your-url'); $this->apiInstance = new Instance($client, $config); $this->x_api_key = "your-apikey"; $this->username = "your-username"; $this->password = "your-password"; }
步骤 5. 捕获请求数据
必须有一个 setUp(),它将负责签名和验证请求。
注意: 下一个请求的数据仅作示例。
public function testGetReporte() { try{ $request = new Peticion(); $persona = new Persona(); $domicilio = new Domicilio(); $request->setFolioOtorgante(""); $persona->setPrimerNombre(""); $persona->setSegundoNombre(""); $persona->setApellidoPaterno(""); $persona->setApellidoMaterno(""); $persona->setFechaNacimiento(""); $domicilio->setDireccion(""); $domicilio->setColoniaPoblacion(""); $domicilio->setDelegacionMunicipio(""); $domicilio->setCiudad(""); $domicilio->setEstado(""); $domicilio->setCP(""); $domicilio->setPais(""); $persona->setDomicilio($domicilio); $request->setPersona($persona); $response = $this->apiInstance->getReporte($this->x_api_key,$this->username,$this->password, $request); $this->assertNotNull($response ); print_r($response); } catch(Exception $e){ echo 'Exception when calling ApiTest->testGetReporte: ', $e->getMessage(), PHP_EOL; } } public function testGetReporteFolio() { try{ $request = new PeticionFolio(); $request->setFolioOtorgante(""); $request->setFolioConsulta(""); $response = $this->apiInstance->getReporteFolio($this->x_api_key,$this->username,$this->password, $request); $this->assertNotNull($response ); print_r($response); } catch(Exception $e){ echo 'Exception when calling ApiTest->testGetReporteFolio: ', $e->getMessage(), PHP_EOL; } }
单元测试
要执行单元测试
./vendor/bin/phpunit