README

API para consulta de Trayectorias Laborales (Empleos, Cedulas y Listas).

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. 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 \lae\Client\Interceptor\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

En el archivo test/Api/ApiTest.php se debe modificar la URL (url_API); el usuario (basic_auth_username) y contraseña (basic_auth_password) de autenticación de acceso básica; y la API KEY (x_api_key), como se muestra en el siguiente fragmento de código:

public function setUp()
{
    $this->x_api_key = "your_api_key";
    $this->basic_auth_username = "your-basic-auth-username";
    $this->basic_auth_password = "your-basic-auth-password";
    $this->url_API = "the_url";
    //..code
}

Paso 5. Capturar los datos de 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.

public function testConsultarTrayectorias()
{
    $request = new Busqueda();
    $persona = new PersonaConsulta();
    $domicilio = new DomicilioConsulta();
    $catalogoSexoPersona = new CatalogoSexoPersona();

    $persona->setPrimerNombre("Juan");
    $persona->setApellidoPaterno("Pruebauno");
    $persona->setApellidoMaterno("Pruebauno");
    $persona->setFechaNacimiento("1986-12-01");
    $persona->setSexo($catalogoSexoPersona::M);
    
    $domicilio->setDireccion("TORNO 301 EL ROSARIO");
    $domicilio->setColonia("PEDREGAL DE SANTO DOMINGO");
    $domicilio->setCp("02100");
    
    $request->setClaveEmpresaConsulta("2007310044");
    $request->setFolioConsultaEmpleador("2620100");
    $request->setProductoRequerido(4);
    $request->setPuestoSolicitado("Vendedor");
    $request->setPersona($persona);
    $request->setDomicilio($domicilio);  

    try {
        $result = $this->apiInstance->consultarTrayectorias($this->x_api_key, $request);
        print_r($result);
        
        if($this->apiInstance->getStatusCode() == 200){
            print_r($result);
        }

        $this->assertTrue($this->apiInstance->getStatusCode() == 200);
    } catch (ApiException $e) {

        if($e->getCode() !== 204){
            echo ' code. Exception when calling ApiTest->consultarTrayectorias: ', $e->getResponseBody(), PHP_EOL;
        }
    }
}

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit

apihub-cdc / trayectorias-laborales-client-php

Maintainers

Details