apihub-cdc/fintechscore-simulacion-client-php

dev-release/1.0.0 2021-05-05 19:41 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

Esta API simula la evaluación de riesgo cubriendo las necesidades de las FinTechs como los son: plazos más cortos que van de 1 día hasta 3 meses en promedio, montos de $3.5K promedio, renovaciones con mayor frecuencia, mayores tasas de interés y disponibilidad inmediata.

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/FintechScoreSimulacionApiTest.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:

$config = new Configuration();
        $config->setHost('url');
        $this->x_api_key = "your-apikey";
        $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/FintechScoreSimulacionApiTest.php
*/
public function testGetReporte()
{
     try{
                $request = new Peticion();
                $persona = new Persona();
                $domicilio = new Domicilio();

                $request->setFolioOtorgante("20210304");

                $persona->setApellidoPaterno("SESENTAYDOS");
                $persona->setApellidoMaterno("PRUEBA");
                $persona->setPrimerNombre("JUAN");
                $persona->setSegundoNombre("JUAN");
                $persona->setFechaNacimiento("1965-08-09");
                $persona->setRFC("SEPJ650809JG1");
                
                $domicilio->setDireccion("PASADISO ENCONTRADO 58");
                $domicilio->setColoniaPoblacion("MONTEVIDEO");
                $domicilio->setDelegacionMunicipio("GUSTAVO A MADERO");
                $domicilio->setCiudad("CIUDAD DE MÉXICO");
                $domicilio->setEstado("CDMX");
                $domicilio->setCP("07730");
                $domicilio->setPais("MX");
            
                $persona->setDomicilio($domicilio);
                $request->setPersona($persona);
                $response = $this->apiInstance->getReporte($this->x_api_key, $request);
                $this->assertNotNull($response );
                print_r($response);

        }
 
        catch(Exception $e){
            echo 'Exception when calling ApiTest->testGetReporte: ', $e->getMessage(), PHP_EOL;
        }
      
}

/**
*Metodo con folios del solicitante
* Este método será ejecutado en la prueba ubicado en path/to/repository/test/Api/FintechScoreSimulacionApiTest.php
*/
    public function testGetReporteFolio()
    {
     try{
                $request = new PeticionFolio();
                $request->setFolioOtorgante("20210301");
                $request->setFolioConsulta("12345678");
                $response = $this->apiInstance->getReporteFolio($this->x_api_key, $request);
                $this->assertNotNull($response );
                print_r($response);
        }
            catch(Exception $e){
                echo 'Exception when calling ApiTest->testGetReporteFolio: ', $e->getMessage(), PHP_EOL;
            }
    }

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

CONDICIONES DE USO, REPRODUCCIÓN Y DISTRIBUCIÓN