README

Esta API simula el Reporte de Crédito Consolidado de Persona Moral.

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/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 testGetReporteCreditoPM()
{
    try {

        $request = new PersonaPeticion();
        $persona = new Persona();
        $domicilio = new PersonaDomicilio(); 
        $catalogoEstados = new CatalogoEstados(); 
        $catalogoPais = new CatalogoPais();            

        $domicilio->setDireccion("AV. PASEO DE LA REFORMA 01");
        $domicilio->setColoniaPoblacion("GUERRERO");
        $domicilio->setDelegacionMunicipio("CUAUHTEMOC");
        $domicilio->setCiudad("CIUDAD DE MÉXICO");
        $domicilio->setEstado($catalogoEstados::DF);
        $domicilio->setCP("68370");
        $domicilio->setPais($catalogoPais::MX);

        $persona->setRFC("EDC930121E01");
        $persona->setNombre("RESTAURANTE SA DE CV");
        $persona->setDomicilio($domicilio);

        $request->setFolioOtorgante("1000001");
        $request->setPersona($persona);

        $result = $this->apiInstance->getReporteCreditoPM($this->x_api_key, $request);
        print_r($result);
    } catch (ApiException | Exception $e) {
        echo 'Exception when calling ApiTest->testGetReporteCreditoPM: ', $e->getMessage(), PHP_EOL;
    }        
}

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

CONDICIONES DE USO, REPRODUCCIÓN Y DISTRIBUCIÓN

apihub-cdc / rcc-pm-simulacion-client

Maintainers

Details