apihub-cdc / fico-score-insurance-client-php
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- 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-04-10 02:44:31 UTC
README
Determina la probabilidad de incumplimiento de un acreditado en los próximos doce meses.
Requisitos
PHP 7.1 ó superior
Dependencias adicionales
- Se debe contar con las siguientes dependencias de PHP:
- ext-curl
- ext-mbstring
- En caso de no ser así, para linux use los siguientes comandos
#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 vea como instalar
Instalación
Ejecutar: composer install
Guía de inicio
Paso 1. Generar llave y certificado
- Se tiene que tener un contenedor en formato PKCS12.
- En caso de no contar con uno, ejecutar las instrucciones contenidas en lib/Interceptor/key_pair_gen.sh ó con los siguientes comandos.
- opcional: Para cifrar el contenedor, colocar una contraseña en una variable de ambiente.
export KEY_PASSWORD=your_password
- Definir los 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
- Generar llave y certificado.
#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}"
- Generar contenedor en formato 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}
Paso 2. Carga del certificado dentro del portal de desarrolladores
- Iniciar sesión.
- Dar clic en la sección "Mis aplicaciones".
- Seleccionar la aplicación.
- Ir a la pestaña de "Certificados para @tuApp".
- Al abrirse la ventana emergente, seleccionar el certificado previamente creado y dar clic en el botón "Cargar":
Paso 3. Descarga del certificado de Círculo de Crédito dentro del portal de desarrolladores
- Iniciar sesión.
- Dar clic en la sección "Mis aplicaciones".
- Seleccionar la aplicación.
- Ir a la pestaña de "Certificados para @tuApp".
- Al abrirse la ventana emergente, dar clic al botón "Descargar":
Es importante que este contenedor sea almacenado en la siguiente ruta: /path/to/repository/lib/Interceptor/keypair.p12
Así mismo el certificado proporcionado por círculo de crédito en la siguiente ruta: /path/to/repository/lib/Interceptor/cdc_cert.pem
- En caso de que no se almacene así, se debe especificar la ruta donde se encuentra el contenedor y el certificado. Ver el siguiente ejemplo:
/** * Esto es parte del setUp() de las pruebas unitarias. */ $password = getenv('KEY_PASSWORD'); $this->signer = new \FicoScoreInsurance\Client\Interceptor\KeyHandler( "/example/route/keypair.p12", "/example/route/cdc_cert.pem", $password );
NOTA: Sólamente en caso de que el contenedor haya cifrado, se debe colocar la contraseña en una variable de ambiente e indicar el nombre de la misma, como se ve en la imagen anterior.
Paso 4. Capturar los datos de la petición
Los siguientes datos a modificar se encuentran en test/Api/ApiTest.php
Es importante contar con el setUp() que se encargará de inicializar la url, firmar y verificar la petición. Modificar la URL de la petición del objeto $config, como se muestra en el siguiente fragmento de código:
<?php public function setUp() { $password = getenv('KEY_PASSWORD'); $this->signer = new \FicoScoreInsurance\Client\Interceptor\KeyHandler(null, null, $password); $events = new \FicoScoreInsurance\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 \FicoScoreInsurance\Client\Configuration(); $config->setHost('the_url'); $this->apiInstance = new \FicoScoreInsurance\Client\Api\FicoScoreInsuranceApi($client,$config); }
<?php /** * Este es el método que se será ejecutado en la prueba ubicado en path/to/repository/test/Api/ApiTest.php */ public function testGetFicoscore() { $x_api_key = "your_api_key"; $username = "your_username"; $password = "your_password"; $requestPersona = new \FicoScoreInsurance\Client\Model\Persona(); $requestDomicilio = new \FicoScoreInsurance\Client\Model\Domicilio(); $requestDomicilio->setDireccion(null); $requestDomicilio->setColonia(null); $requestDomicilio->setCiudad(null); $requestDomicilio->setCodigoPostal(null); $requestDomicilio->setMunicipio(null); $requestDomicilio->setEstado($requestDomicilio::ESTADO_AGS); $requestPersona->setPrimerNombre("NOMBRE"); $requestPersona->setSegundoNombre(null); $requestPersona->setApellidoPaterno("PATERNO"); $requestPersona->setApellidoMaterno("MATERNO"); $requestPersona->setApellidoAdicional(null); $requestPersona->setFechaNacimiento("07-01-1980"); $requestPersona->setRfc(null); $requestPersona->setCurp(null); $requestPersona->setDomicilio($requestDomicilio); try { $result = $this->apiInstance->getFicoscore($x_api_key, $username, $password, $requestPersona); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiTest->getFicoscore: ', $e->getMessage(), PHP_EOL; } } ?>
Pruebas unitarias
Para ejecutar las pruebas unitarias:
./vendor/bin/phpunit