README

Esta API simula la sustitución de la firma autógrafa para sustentar la autorización por medio de NIP, huella digital o dicio.

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');
    $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.

public function testNip()
{
    try {
        $peticion = new SustitucionNIPPeticion();
        $persona = new Persona();
        $domicilio = new Domicilio();
        $catalogoEstados = new CatalogoEstados(); 
        $catalogoTipoPersona = new CatalogoTipoPersona();


        $domicilio->setCalleNumero("AV 535 84");
        $domicilio->setColonia("SAN JUAN DE ARAGON 1RA SECC");
        $domicilio->setCiudad( "CIUDAD DE MEXICO");
        $domicilio->setEstado($catalogoEstados::CDMX);
        
        $persona->setPrimerNombre("NOMBRE");
        $persona->setSegundoNombre("SEGUNDONOMBRE");
        $persona->setApellidoPaterno("PATERNO");
        $persona->setApellidoMaterno("MATERNO");
        $persona->setApellidoAdicional(null);
        $persona->setRFC("PUAP850316MI1");
        $persona->setDomicilio($domicilio);

        $peticion->setFolioCDC(763211111);
        $peticion->setFechaConsulta("2021/04/15");
        $peticion->setHoraConsulta("10/12/35");
        $peticion->setTipoConsulta($catalogoTipoPersona::PF);
        $peticion->setUsuario("NGA9915CC5");
        $peticion->setFechaAprobacionConsulta("2021/04/15");
        $peticion->setHoraAprobacionConsulta("10/12/35");
        $peticion->setIngresoNuevamenteNIP(true);
        $peticion->setRespuestaLeyendaAutorizacion(true);
        $peticion->setAceptaTerminosCondiciones(true);
        $peticion->setNumeroFirma("1234F");
        $peticion->setPersona($persona);

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

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

CONDICIONES DE USO, REPRODUCCIÓN Y DISTRIBUCIÓN