README

Esta API simula el reporte del historial crediticio, 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 os 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/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');
    $this->x_api_key = "your_x_api_key";
    $client = new Client();
    $this->apiInstance = new Instance($client,$config);
}

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 testGetFullReporte()
{

    $request = new PersonaPeticion();
    
    $request->setPrimerNombre("JUAN");
    $request->setApellidoPaterno("PRUEBA");
    $request->setApellidoMaterno("SIETE");
    $request->setRfc("PUAC800107");
    $request->setFechaNacimiento("1980-01-07");
    $request->setNacionalidad("MX");

    $domicilio = new DomicilioPeticion();
    $domicilio->setDireccion("INSURGENTES SUR 1001");
    $domicilio->setColoniaPoblacion("INSURGENTES SUR");
    $domicilio->setCiudad("CIUDAD DE MEXICO");
    $domicilio->setCp("11230");
    $domicilio->setDelegacionMunicipio("CIUDAD DE MEXICO");
    $domicilio->setEstado("DF");
    $request->setDomicilio($domicilio); 
    
    try {
        $result = $this->apiInstance->getReporte($this->x_api_key, $request);
        $this->assertNotNull($result);
        print_r($result);
        echo "testGetFullReporte finished\n";
    } catch (Exception $e) {
        echo 'Exception when calling ApiTest->getReporte: ', $e->getMessage(), PHP_EOL;
    }
}

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

CONDICIONES DE USO, REPRODUCCIÓN Y DISTRIBUCIÓN

apihub-cdc / rc-simulacion-client

Maintainers

Details