توضيح واجهة برمجة التطبيقات للتعرف على الهوية والتحقق من المعلومات

​

عملية التقديم

📘 الوثائق الكاملة: واجهة برمجة التطبيقات للتعرف على الهوية والتحقق من المعلومات →

​

الاستخدام الأساسي

• accept: نوع الاستجابة التي ترغب في تلقيها، هنا يتم ملؤها بـ application/json، أي بتنسيق JSON.
• authorization: مفتاح استدعاء واجهة برمجة التطبيقات، يمكن اختياره مباشرة بعد التقديم.

• image_url: رابط صورة الهوية التي تحتاج إلى المعالجة.
• encryption: اختياري، معلمة تشفير الحقول الحساسة (إذا كان هناك حاجة لإرسال نص مشفر).

{
  "result": "0",
  "description": "الاسم ورقم الهوية متطابقان",
  "name": "اسم الهوية",
  "id_card": "رقم الهوية",
  "sex": "جنس الهوية",
  "nation": "أمة الهوية",
  "birth": "تاريخ ميلاد الهوية",
  "address": "عنوان السكن في الهوية"
}

• result، رمز نتيجة التحقق، وتفاصيل الرسوم كما يلي.
  • رموز النتائج المدفوعة:
    • 0: الاسم ورقم الهوية متطابقان
    • -1: الاسم ورقم الهوية غير متطابقين
  • رموز النتائج غير المدفوعة:
    • -2: رقم هوية غير قانوني (طول، رقم تحقق، إلخ غير صحيح)
    • -3: اسم غير قانوني (طول، تنسيق، إلخ غير صحيح)
    • -4: خطأ في خدمة قاعدة البيانات
    • -5: لا يوجد سجل لهذا الرقم في قاعدة البيانات
    • -6: نظام المقارنة المعتمد في مرحلة التحديث، يرجى المحاولة لاحقًا
    • -7: عدد مرات التحقق تجاوز الحد اليومي.
• description، هنا نتيجة التحقق من الاسم ورقم الهوية.
• name، معلومات الاسم في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• id_card، معلومات رقم الهوية في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• sex، معلومات الجنس في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• nation، معلومات الأمة في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• birth، معلومات تاريخ الميلاد في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• address، معلومات عنوان السكن في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.

curl -X POST 'https://api.acedata.cloud/identity/idcard/ocr' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'

import requests

url = "https://api.acedata.cloud/identity/idcard/ocr"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "image_url": {image_url}
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​

التحقق من المعلومات المخصصة

{
    "address": "",
    "birth": "",
    "description": "الاسم ورقم الهوية متطابقان",
    "id_card": "رقم الهوية",
    "name": "اسم الهوية",
    "nation": "",
    "result": "0",
    "sex": ""
 }

​

معالجة الأخطاء

• 400 token_mismatched: طلب غير صحيح، ربما بسبب معلمات مفقودة أو غير صحيحة.
• 400 api_not_implemented: طلب غير صحيح، ربما بسبب معلمات مفقودة أو غير صحيحة.
• 401 invalid_token: غير مصرح، رمز تفويض غير صالح أو مفقود.
• 429 too_many_requests: عدد كبير جدًا من الطلبات، لقد تجاوزت الحد المسموح به.
• 500 api_error: خطأ في الخادم الداخلي، حدث خطأ ما على الخادم.

​

مثال على استجابة الخطأ

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "فشل في الاسترجاع"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​

الخاتمة