README

Devuelve una calificación de acuerdo a los datos financieros basada en el modelo de FICO Score.

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 \APIHub\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

Los siguientes datos a modificar se encuentran en test/Api/FicoScoreApiTest.php

El setUp() que se encargará de inicializar la url. Modificar la URL ('the_url') de la petición del objeto $config, como se muestra en el siguiente fragmento de código:

$config = new \FicoscorePeru\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.

<?php
public function setUp()
  {
    $password = getenv('KEY_PASSWORD');
    $this->signer = new \FicoscorePeru\Client\Interceptor\KeyHandler(null, null, $password);
    $events = new \FicoscorePeru\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'));
    $config = new \FicoscorePeru\Client\Configuration();
    $config->setHost('the_url');

    $client = new \GuzzleHttp\Client(['handler' => $handler]);
    $this->apiInstance = new \FicoscorePeru\Client\Api\FicoScoreApi($client, $config);
  }

<?php

public function testFicoScoreApi()
  {
    $x_api_key = "your_api_key";
    $username = "your_username";
    $password = "your_password";

    $request = new \FicoscorePeru\Client\Model\DatosConsulta();

    $request->setNumeroDocumento('xxxxx');
    $request->setTipoDocumento('x');
    $request->setFolioConsultaOtorgante(null);

    try {
      $result = $this->apiInstance->ficoScore($x_api_key, $username, $password, $request);
        $this->assertNotNull($result);
      } catch (Exception $e) {
        echo 'Exception when calling FicoScoreApi->ficoScore: ', $e->getMessage(), PHP_EOL;
    }
  }
?>

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

apihub-cdc / ficoscore-peru-client-php

Maintainers

Details