megacreativo/cedulave-api

CedulaVE API permite consultar datos personales de habitantes de Venezuela inscritos en el CNE mediante su C茅dula de Identidad.

v1.1.2 2022-11-22 19:39 UTC

This package is not auto-updated.

Last update: 2025-03-26 06:40:15 UTC


README

GitHub issues GitHub forks GitHub license StyleCI

CedulaVE API es un script escrito en PHP para consultar datos personales de habitantes de Venezuela inscritos en el CNE mediante su C茅dula de Identidad.

馃 Contibuci贸n

ko-fi

Contribuciones, problemas y solicitudes de funciones son bienvenidos. Si茅ntase libre de consultar los issues si quieres contribuir.

馃捊 Instalaci贸n

La forma m谩s f谩cil de instalar CedulaVE API es a trav茅s de Composer

composer require megacreativo/cedulave-api

馃摐 Ejemplo PHP

El m茅todo info est谩 disponible para ejecutar la consula, las respuesta se obtiene por defecto en formato JSON

Consultar la API

Para ver m谩s ejemplos valla a examples

/**
 * Estructura de parametros
 * 
 * @param string   $nac     Tipo de Nacionalidad. Valores permitidos [V|E]. Cualquier otro valor producir谩 un Error 301
 * @param string   $cedula  N煤mero de C茅dula de Identidad a consultar
 * @param boolean  $json    (Opcional) Si es true devolver JSON como respuesta, en caso contrario devuelve un ARRAY. Valor por defecto TRUE
 * @param boolean  $pretty  (Opcional) Se devuelve un JSON, este parametro establece si se aplica JSON_PRETTY_PRINT. Valor por defecto FALSE
 */
function info(string $nac, string $cedula, bool $json = true, bool $pretty = false)


/**
 * Ejemplos de uso
 **/
// Retorna un JSON
CedulaVE::info('V', '12345678');

// Retorna un Array
CedulaVE::info('V', '12345678', false);

// Retorna un JSON formateado 
vCedulaVE::info('V', '12345678', true, true);

Respuesta exitosa

{
    "status": 200,
    "version": "1.1.1",
    "website": "https://api.megacreativo.com/public/cedula-ve/v1",
    "response":
    {
        "nac": "V", /* Nacionalidad. [V|E] */
        "dni": "12345678", /* C茅dula de identidad */
        "name": "Jhon Alfred", /* Primer y segundo nombre */
        "lastname": "Doe Law", /* Primer y segundo apellido */
        "fullname": "Jhon Alfred Doe Law", /* Nombre completo */
        "state": "Estado", /* Estado donde se encuentra el Centro de votaci贸n */
        "municipality": "Municipio", /* Municipio del Centro de votaci贸n */
        "parish": "Parroquia", /* Parroquia del Centro de votaci贸n */
        "voting": "Centro de votaci贸n", /* Nombre del Centro de votaci贸n */     
        "address": "Direccion" /* Direcci贸n del Centro de votaci贸n */
    }
}
Array
(
    [status] => 200
    [version] => 1.1.1
    [api] => https://api.megacreativo.com/public/cedula-ve/v1
    [data] => Array
        (
            [nac] => V
            [dni] => 12345678
            [name] => JHON ALFRED
            [lastname] => DOE LAW
            [fullname] => JHON ALFRED DOE LAW
            [state] => ESTADO
            [municipality] => MUNICIPIO
            [parish] => PARROQUIA
            [voting] => CENTRO DE VOTACION
            [address] => DIRECCION DEL CENTRO
        )

)

Respuestas de error

Error 404 La c茅dula consultada no est谩 inscrita en el CNE

{
    "status": 404,
    "version": "1.1.1",
    "api": "https://api.megacreativo.com/public/cedula-ve/v1",
    "data": {
        "code": 404,
        "message": "No se encontr贸 la c茅dula de identidad"
    }
}

Error 301 Los datos recibidos no son correctos, Error en la nacionalidad. Valores permitidos [V|E]

{
    "status": 301,
    "version": "1.1.1",
    "api": "https://api.megacreativo.com/public/cedula-ve/v1",
    "data": {
        "code": 301,
        "message": "Los datos recibidos no son correctos, Error en la nacionalidad. Valores permitidos [V|E]"
    }
}

Error 302 Los datos recibidos no son correctos. Se introdujo un caracter no numerico

{
    "status": 302,
    "version": "1.1.1",
    "api": "https://api.megacreativo.com/public/cedula-ve/v1",
    "data": {
        "code": 302,
        "message": "Los datos recibidos no son correctos. Se introdujo un caracter no numerico"
    }
}

Error 303 Los datos recibidos no son correctos. Se introdujo un caracter no numerico

{
    "status": 303,
    "version": "1.1.1",
    "api": "https://api.megacreativo.com/public/cedula-ve/v1",
    "data": {
        "code": 303,
        "message": "Debe ingresar una cedula de indetidad v谩lida. S贸lo se permiten caracteres num茅ricos"
    }
}

馃懁 Author

Brayan Rinc贸n

  • Github: [@bracodev][link-bracodev]

馃搶 Versiones

We use SemVer for versioninWg. For all available versions, look at the tags in this repository.

馃摑 Licencia

The software is distributed under the MIT license. Copyright 漏 2018-2020. Made with 鉂わ笍 by Brayan Rincon & MegaCreativo https://megacreativo.com