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. Agregar el producto a la aplicación

Al iniciar sesión seguir los siguientes pasos:

Dar clic en la sección "Mis aplicaciones".
Seleccionar la aplicación.
Ir a la pestaña de "Editar '@tuApp' ".
Al abrirse la ventana emergente, seleccionar el producto.
Dar clic en el botón "Guardar App":

Paso 2. Capturar los datos de la petición

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

Es importante contar con 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:

<?php
public function setUp()
{
    $config = new \FicoscorePeruSandbox\Client\Configuration();
    $config->setHost('the_url');

    $client = new \GuzzleHttp\Client();
    $this->apiInstance = new \FicoscorePeruSandbox\Client\Api\FicoScoreApi($client, $config);
}

<?php
/**
* Este es el método que se será ejecutado en la prueba ubicado en path/to/repository/test/Api/FicoScoreApiTest.php
*/
public function testReportarEnLineaSimulacion()
{
    $x_api_key = "your_api_key";
    $request = new \FicoscorePeruSandbox\Client\Model\DatosConsulta();

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

    try {
        $result = $this->apiInstance->ficoScore($x_api_key, $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-simulacion-client-php

Maintainers

Details