ficoscore-client-php

La API de FICO Score determina la probabilidad de incumplimiento de un acreditado en los próximos doce meses. A mayor puntaje de score, menor es el riesgo.

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

1. Iniciar sesión.
2. Dar clic en la sección "Mis aplicaciones".
3. Seleccionar la aplicación.
4. Ir a la pestaña de "Certificados para @tuApp".

   

5. 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

1. Iniciar sesión.
2. Dar clic en la sección "Mis aplicaciones".
3. Seleccionar la aplicación.
4. Ir a la pestaña de "Certificados para @tuApp".

   

5. 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/ApiTest.php, como se muestra en el siguiente fragmento de código:

public function setUp()
{
    $password = getenv('KEY_PASSWORD');
    $this->signer = new KeyHandler(null, null, $password);

    $events = new MiddlewareEvents($this->signer);
    $handler = handlerStack::create();
    $handler->push($events->add_signature_header('x-signature'));   
    $handler->push($events->verify_signature_header('x-signature'));
    $client = new Client(['handler' => $handler]);

    $config = new Configuration();
    $config->setHost('the_url');
    
    $this->apiInstance = new Instance($client, $config);
    $this->x_api_key = "your_api_key";
    $this->username = "your_username";
    $this->password = "your_password";
}   

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 testGetReporte() {

    $request = new Peticion();
    $persona = new Persona();
    $domicilio = new Domicilio();
    $estado = new CatalogoEstados();

    $request->setFolio("00000001");

    $persona->setNombres("JUAN");
    $persona->setApellidoPaterno("PRUEBA");
    $persona->setApellidoMaterno("SIETE");
    $persona->setFechaNacimiento("1980-01-07");
    $persona->setRFC("PUAC800107");

    $domicilio->setDireccion("INSURGENTES SUR 1001");
    $domicilio->setColoniaPoblacion("INSURGENTES SUR");
    $domicilio->setCiudad("CIUDAD DE MEXICO");        
    $domicilio->setDelegacionMunicipio("CIUDAD DE MEXICO");
    $domicilio->setEstado($estado::DF);
    $domicilio->setCP("11230");

    $persona->setDomicilio($domicilio);

    $request->setPersona($persona);

    try {
        $result = $this->apiInstance->getReporte($this->x_api_key, $this->username, $this->password, $request);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling ApiTest->getReporte: ', $e->getMessage(), PHP_EOL;
    }
}

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit