1. Introducción


Bienvenido a la documentaci√≥n oficial de CRC PEP REQUEST, un API que provee a los desarrolladores de empresas afiliadas a conectar sus sistemas para poder realizar búsquedas de Personas Expuestas Politicamente PEPs desde cualquiera de sus plataformas.

Recomendamos leer el apartado de Instalacion mas abajo para el manejo apropiado y consumo eficinete de nuestra REST API.


Autor: ClusterNat EIRL
Contacto: info@clusternat.com
website: http://www.clusternat.com/

2. Implementación

Para acceder a la API primero es necesario hacer la solicitud a CRCRD de su API ID y API TOKEN, los cuales son necesarios para hacer la conexión; estas serviran de credenciales de validación y se tienen que enviar juntamente con la cédula para hacer la búsqueda, a través de peticiones POST al API.

  
POST /parametros /autorización
{
    "api_id" :"",  Id de la entidad-> REQUERIDO
    "api_token": "", Token de la entidad -> REQUERIDO
    "api_cedula" :"",  Cedula de la busqueda -> REQUERIDO  
}

                                        

NOTA: El API ID y API TOKEN son únicos para la entidades, lo que no deben compartirse y de ser necesario la actualización del API TOKEN se deben comunicar a nuestras oficinas.

3. Ejemplo en PHP

El siguiente código es un ejemplo de implementar una llamada desde PHP

  
<?php
$url = 'https://crcrd.app/ipepapi_server';
$ch = curl_init($url);
$api_id = "idusuario";
$api_token = "RVROdnRuS1l6RmtwQmVKYmZpVXdJck9NWDRSwQmVKYxseDNIZGoxUUNnVnljdVdzRzc=";
$parametros = array(
    "api_id" => $api_id,
    "api_token" => $api_token,
    "api_cedula" => "00000000000"
    );
//Hacer el envio del POST
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($parametros));//se envian los parametros en formato JSON

//Establecer el content type a application/json
$headers = array();
$headers[] = 'Cache-Control: no-cache';
$headers[] = 'Content-Type: application/json; charset= utf-8';

//Establecer valores en el header
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

//Devolver respuesta
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

//Ejecuto el POST request
$result = json_decode(curl_exec($ch),true);// manejo de JSON a arreglo
print_r($result);//impresion del arreglo lsito para su uso
curl_close($ch);
?>   

                                        

4. Respuesta

La API devuelve un arreglo en formato JSON que varia dependiendo de los datos encontrados juntamente con los códigos de respuesta

Respuesta Descripción
api_response_code (int) Código de respuesta de la API
api_error (bool) Indica si la respuesta es satisfactoria o un error
api_error_msg (string) Mensaje detallado de error (cuando aplique)
pep_valido (bool) Indica si la persona buscada es un PEP o no
Si la persona no es PEP no devuelve este valor
api_fuente (string) Si la persona buscada es un PEP indica si es PEP por cargo o relacionado a un PEP
Si la persona no es PEP no devuelve este valor
rel_nombre (string) Si la persona buscada es un relacionado a un PEP, en este apartado se muestra su nombre
Si la persona no es PEP por relacion no devuelve este valor
rel_parentesco (string) Muestra el parentesco del relacionado a un PEP
Si la persona no es PEP por relacion no devuelve este valor
pep_nombre (string) Muestra el nombre del PEP
Si la persona no es PEP no devuelve este valor
pep_cargo (string) Muestra el cargo del PEP
Si la persona no es PEP no devuelve este valor

5. Códigos de Respuesta

A continuación se muestra un listado de los códigos de respuesta de la API.

Código de Respuesta Descripción
200 Peticion sin error
400 Indica que hay valores incorrectos en la petición
401 Acceso no autorizado
405 Metodo no autorizado para la petición (solo se acepta peticiones POST)
500 Error interno del servidor
© 2022 ClusterNat EIRL