apihub-cdc/pld-naturales-simulacion-client-php

1.0.2 2020-06-08 15:04 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2
• monolog/monolog: ^1.24

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• PLDNaturalesSimulacion and contributors

• php
• api
• sdk
• apihub

README

Devuelve las coinicidencias de las personas que se encuentran en listas nacionales e internacionales de Prevención de Lavado de Dinero (entorno de simulación).

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 os 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 url. Modificar la URL ('the_url') de la petición del objeto $config, como se muestra en el siguiente fragmento de código:

<?php
public function setUp()
{
    $handler = \GuzzleHttp\HandlerStack::create();
    $config = new \PLDNaturalesSimulacion\Client\Configuration();
    $config->setHost('the_url');

    $client = new \GuzzleHttp\Client(['handler' => $handler, 'verify' => false]);
    $this->apiInstance = new \PLDNaturalesSimulacion\Client\Api\PLDNaturalesSimulacionApi($client,$config);
} 

<?php
/**
* Este es el método que se será ejecutado en la prueba ubicado en path/to/repository/test/Api/ApiTest.php 

*/
public function testPldNaturales()
{
    $x_api_key = "your_api_key";

    $request = new \PLDNaturalesSimulacion\Client\Model\Peticion();
    
    $request->setFolio("000008");
    $request->setTipoDocumento("01");
    $request->setNumeroDocumento("01");
    $request->setNombre("Maria");
    $request->setSegundoNombre(null);
    $request->setApellidoPaterno("Sanchez");
    $request->setApellidoMaterno("Mathews");

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

Pruebas unitarias

Para ejecutar las pruebas unitarias:

./vendor/bin/phpunit