تنزيل CedulaVE API - تنزيل كود مصدر CedulaVE API

CedulaVE API

فئات أخرى

v1.1.2

تنزيل

CedulaVE API

CedulaVE API هو برنامج نصي مكتوب بلغة PHP للاطلاع على البيانات الشخصية للمقيمين الفنزويليين المسجلين في CNE من خلال بطاقة الهوية الخاصة بهم.

؟ مساهمة

نرحب بالمساهمات والقضايا وطلبات الميزات. لا تتردد في التحقق من القضايا إذا كنت تريد المساهمة.

؟ منشأة

أسهل طريقة لتثبيت CedulaVE API هي من خلال Composer

composer require megacreativo/cedulave-api

مثال PHP

يتوفر أسلوب المعلومات لتنفيذ الاستعلام، ويتم الحصول على الاستجابة افتراضيًا بتنسيق JSON

الاستعلام عن API

لرؤية المزيد من الأمثلة انتقل إلى الأمثلة

 /**
 * 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 "
    }
}