verificacion-expediente-client-php

API Verificación Expediente.

Requisitos

PHP >= 7.2

Dependencias adicionales

Composer vea como instalar
Se debe contar con las siguientes dependencias de PHP:
- ext-curl
- ext-mbstring

# RHEL distros
yum install php-mbstring
yum install curl

# Debian distros
apt-get install php-mbstring
apt-get install php-curl

Instalación

Ejecutar: composer install

Guía de inicio

Paso 1. Generar llave y certificado

Se tiene que tener un contenedor en formato PKCS12.
En caso de no contar con uno, ejecutar las instrucciones contenidas en lib/Interceptor/key_pair_gen.sh o con los siguientes comandos.

Opcional: Para cifrar el contenedor, colocar una contraseña en una variable de ambiente.

export KEY_PASSWORD=your_password

Definir los nombres de archivos y alias.

export PRIVATE_KEY_FILE=pri_key.pem
export CERTIFICATE_FILE=certificate.pem
export SUBJECT=/C=MX/ST=MX/L=MX/O=CDC/CN=CDC
export PKCS12_FILE=keypair.p12
export ALIAS=circulo_de_credito

Generar llave y certificado.

#Genera la llave privada.
openssl ecparam -name secp384r1 -genkey -out ${PRIVATE_KEY_FILE}
#Genera el certificado público.
openssl req -new -x509 -days 365 \
    -key ${PRIVATE_KEY_FILE} \
    -out ${CERTIFICATE_FILE} \
    -subj "${SUBJECT}"

Generar contenedor en formato PKCS12.

# Genera el archivo pkcs12 a partir de la llave privada y el certificado.
# Deberá empaquetar la llave privada y el certificado.
openssl pkcs12 -name ${ALIAS} \
    -export -out ${PKCS12_FILE} \
    -inkey ${PRIVATE_KEY_FILE} \
    -in ${CERTIFICATE_FILE} -password pass:${KEY_PASSWORD}

Paso 2. Cargar el certificado dentro del portal de desarrolladores

Iniciar sesión.
Dar clic en la sección "Mis aplicaciones".
Seleccionar la aplicación.
Ir a la pestaña de "Certificados para @tuApp".
Al abrirse la ventana, seleccionar el certificado previamente creado y dar clic en el botón "Cargar":

Paso 3. Descargar el certificado de Círculo de Crédito dentro del portal de desarrolladores

Iniciar sesión.
Dar clic en la sección "Mis aplicaciones".
Seleccionar la aplicación.
Ir a la pestaña de "Certificados para @tuApp".
Al abrirse la ventana, dar clic al botón "Descargar":

Es importante que este contenedor sea almacenado en la siguiente ruta: /path/to/repository/lib/Interceptor/keypair.p12

Así mismo el certificado proporcionado por Círculo de Crédito en la siguiente ruta: /path/to/repository/lib/Interceptor/cdc_cert.pem

En caso de que no se almacene así, se debe especificar la ruta donde se encuentra el contenedor y el certificado. Ver el siguiente ejemplo:

$password = getenv('KEY_PASSWORD');
$this->signer = new KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
);

NOTA: Solamente en caso de que el contenedor se haya cifrado, debe colocarse la contraseña en una variable de ambiente e indicar el nombre de la misma, como se ve en la imagen anterior.

Paso 4. Modificar URL y credenciales

Modificar la URL y las credenciales de acceso a la petición en test/Api/VerificacionDeExpedienteApiTest.php, como se muestra en el siguiente fragmento de código:

username = "your-cdc-username"; $this->password = "your-cdc-password"; $apiUrl = "https://api-url"; $keystorePassword = "your-keystore-password"; $keystore = 'your-keystore-pkcs.p12'; $cdcCertificate = 'circulo-credito-certificate.pem'; $signer = new KeyHandler($keystore, $cdcCertificate, $keystorePassword); $events = new MiddlewareEvents($signer); $handler = HandlerStack::create(); $handler->push($events->add_signature_header('x-signature')); $handler->push($events->verify_signature_header('x-signature')); $this->config = new Configuration(); $this->config->setHost($apiUrl); $this->httpClient = new HttpClient([ 'handler' => $handler ]); } ...">

...
public  function setUp():  void {

    $this->apiKey   =  "your-api-key";
    $this->username =  "your-cdc-username";
    $this->password =  "your-cdc-password";

    $apiUrl            =  "https://api-url";
    $keystorePassword  =  "your-keystore-password";
    $keystore          =  'your-keystore-pkcs.p12';
    $cdcCertificate    =  'circulo-credito-certificate.pem';
    
    $signer  = new KeyHandler($keystore, $cdcCertificate, $keystorePassword);
    $events  = new MiddlewareEvents($signer);
    $handler = HandlerStack::create();
    $handler->push($events->add_signature_header('x-signature'));
    $handler->push($events->verify_signature_header('x-signature'));

    $this->config =  new Configuration();
    $this->config->setHost($apiUrl);
    
    $this->httpClient =  new HttpClient([
        'handler'  =>  $handler
    ]);
}
...

Paso 5. Capturar los datos y realizar la petición

Es importante contar con el setUp() que se encargará de firmar y verificar la petición.

NOTA: Los datos de la siguiente petición son solo representativos.

setDelegacionMunicipio("Miguel Hidalgo"); $domicilio->setCiudad("Mexico"); $domicilio->setEstado(CatalogoEstados::CDMX); $domicilio->setCodigoPostal("37576"); $domicilio->setNumeroTelefono("55100000"); $persona = new Persona(); $persona->setNombres("Juan"); $persona->setApellidoPaterno("Prueba"); $persona->setApellidoMaterno("Prueba"); $persona->setFechaNacimiento("1990-04-04"); $persona->setRFC("PUSJ800107"); $persona->setCURP("PUSJ80010722JUYTRD"); $persona->setClaveElectorIFE("PUSJ800107"); $persona->setSexo(CatalogoSexo::M); $persona->addDomicilio($domicilio); $personas = new Personas(); $personas->setFolio("1003"); $personas->addPersona($persona); $payload = new PayloadRequest(); $payload->setPersonas($personas); $payload->setFolioOtorgante("1003"); $response = null; try { $client = new ApiClient($this->httpClient, $this->config); $response = $client->getReporte($this->apiKey, $this->username, $this->password, $payload); print("\n".$response); } catch (ApiException $exception) { print("\nThe HTTP request failed, an error occurred: ".($exception->getMessage())); print("\n".$exception->getResponseObject()); } $this->assertNotNull($response); } ...">

...
public  function testGetReporte()  {

    $domicilio  =  new Domicilio();
    $domicilio->setDireccion("Insurgentes Sur 100007");
    $domicilio->setDelegacionMunicipio("Miguel Hidalgo");
    $domicilio->setCiudad("Mexico");
    $domicilio->setEstado(CatalogoEstados::CDMX);
    $domicilio->setCodigoPostal("37576");
    $domicilio->setNumeroTelefono("55100000");

    $persona  =  new Persona();
    $persona->setNombres("Juan");
    $persona->setApellidoPaterno("Prueba");
    $persona->setApellidoMaterno("Prueba");
    $persona->setFechaNacimiento("1990-04-04");
    $persona->setRFC("PUSJ800107");
    $persona->setCURP("PUSJ80010722JUYTRD");
    $persona->setClaveElectorIFE("PUSJ800107");
    $persona->setSexo(CatalogoSexo::M);
    $persona->addDomicilio($domicilio);

    $personas  =  new Personas();
    $personas->setFolio("1003");
    $personas->addPersona($persona);

    $payload  =  new PayloadRequest();
    $payload->setPersonas($personas);
    $payload->setFolioOtorgante("1003");

    $response = null;

    try  {
        $client = new ApiClient($this->httpClient, $this->config);
        $response = $client->getReporte($this->apiKey, $this->username, $this->password, $payload);
        print("\n".$response);
        
    }  catch  (ApiException $exception)  {
        print("\nThe HTTP request failed, an error occurred: ".($exception->getMessage()));
        print("\n".$exception->getResponseObject());
    }

    $this->assertNotNull($response);
}
...