apihub-cdc/ficoscore-simulacion-client

Esta API simula las calificaciones de FICO® Score.

2.0.1 2020-11-12 22:55 UTC

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

proprietary

• APIHub and contributors

• php
• api
• sdk
• apihub

README

La API de FICO Score determina la probabilidad de incumplimiento de un acreditado en los próximos doce meses. A mayor puntaje de score, menor es el riesgo.

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:

1. Dar clic en la sección "Mis aplicaciones".
2. Seleccionar la aplicación.
3. Ir a la pestaña de "Editar '@tuApp' ".

   

4. Al abrirse la ventana emergente, seleccionar el producto.
5. 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/ApiTest.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 Configuration();
    $config->setHost('the_url');
    $client = new Client();
    $this->apiInstance = new Instance($client, $config);
    $this->x_api_key = "your_x_api_key";
}  

<?php
/**
* Este es el método que se será ejecutado en la prueba ubicado en path/to/repository/test/Api/ApiTest.php
*/
public function testGetReporte()
{
    $request = new Peticion();
    $persona = new Persona();
    $domicilio = new Domicilio();

    $request->setFolio("123456");
    
    $persona->setNombres("JUAN");
    $persona->setApellidoPaterno("SESENTAYDOS");
    $persona->setApellidoMaterno("PRUEBA");
    $persona->setFechaNacimiento("1965-08-09");
    $persona->setRFC("SEPJ650809JG1");

    $domicilio->setDireccion("PASADISO ENCONTRADO 58");
    $domicilio->setColoniaPoblacion("MONTEVIDEO");
    $domicilio->setCiudad("CIUDAD DE MÉXICO");
    $domicilio->setCP("07730");
    $domicilio->setDelegacionMunicipio("GUSTAVO A MADERO");
    $domicilio->setEstado("CDMX");

    $persona->setDomicilio($domicilio);

    $request->setPersona($persona);

    try {
        $result = $this->apiInstance->getReporte($this->x_api_key, $request);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling ApiTest->testGetReporte: ', $e->getMessage(), PHP_EOL;
    }
}
?>

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

CONDICIONES DE USO, REPRODUCCIÓN Y DISTRIBUCIÓN