undostres-com-mx / rcc-ficoscore-client-php
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-04-29 23:23:14 UTC
README
Este reporte muestra el historial crediticio con los Campos Asociados a Nómina, el cumplimiento de pago de los compromisos que la persona ha adquirido con entidades financieras, no financieras e instituciones comerciales que dan crédito o participan en actividades afines al crédito.
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. Cargar el 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. Descargar el 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:
$password = getenv('KEY_PASSWORD'); $this->signer = new \RCCFicoScore\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. Modificar URL
Modificar la URL de la petición en test/Api/ApiTest.php en la línea 30, como se muestra en el siguiente fragmento de código:
$config = new \RCCFicoScore\Client\Configuration(); $config->setHost('the_url');
Paso 5. Capturar los datos de la petición
Es importante contar con el setUp() que se encargará de firmar y verificar la petición.
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; } }
Pruebas unitarias
Para ejecutar las pruebas unitarias:
./vendor/bin/phpunit