README

Esta API simula el reporta del 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. 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 petición. Por tanto, se debe modificar la URL (the_url) y la API KEY (your_x_api_key), como se muestra en el siguiente fragmento de código:

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";
    $this->x_full_report = 'false';
}

Para la petición se deberá modificar el siguiente fragmento de código con los datos correspondientes:

NOTA: Para más ejemplos de simulación, consulte la colección de Postman.

/**
* Este método será ejecutado en la prueba ubicado en path/to/repository/test/Api/ApiTest.php
*/
public function testGetReporte()
{
    $estado = new CatalogoEstados();
    $nacionalidad = new CatalogoEstados();
    $request = new PersonaPeticion();
    $domicilio = new DomicilioPeticion();        

    $request->setApellidoPaterno("SESENTAYDOS");
    $request->setApellidoMaterno("PRUEBA");
    $request->setPrimerNombre("JUAN");
    $request->setFechaNacimiento("1965-08-09");
    $request->setRfc("SEPJ650809JG1");
    $request->setNacionalidad("MX");

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

    try {
        $result = $this->apiInstance->getReporte($this->x_api_key, $request);
        print_r($result);
        $this->assertTrue($result->getFolioConsulta()!==null);

        return $result->getFolioConsulta();
    } catch (Exception $e) {
        echo 'Exception when calling RCCFS\Simulacion\MXApi->getReporte: ', $e->getMessage(), PHP_EOL;
    }
}

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

CONDICIONES DE USO, REPRODUCCIÓN Y DISTRIBUCIÓN