README

CedulaVE API 是一个用 PHP 编写的脚本，用于通过身份证查询已登记在 CNE 的委内瑞拉居民的个人信息。

🤝 贡献

欢迎贡献、问题和功能请求。如果您想贡献，请自由地查看问题。

💽 安装

安装 CedulaVE API 最简单的方法是通过 Composer。

composer require megacreativo/cedulave-api

📜 PHP 示例

info 方法可用于执行查询，默认以 JSON 格式获取响应。

查询 API

要查看更多示例，请访问 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);

成功响应

{
    "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
        )

)

错误响应

错误 404 查询的身份证未在 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"
    }
}

错误 301 收到的数据不正确，国籍错误。允许的值 [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]"
    }
}

错误 302 收到的数据不正确。输入了非数字字符。

{
    "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"
    }
}

错误 303 收到的数据不正确。输入了非数字字符。

{
    "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"
    }
}

👤 作者

Brayan Rincón

Github: [@bracodev][link-bracodev]

📌 版本

我们使用 SemVer 进行版本管理。查看所有可用版本，请访问此存储库的标签。

megacreativo / cedulave-api

维护者

详细信息