توضيح واجهة برمجة التطبيقات للتحقق من صورة الهوية الشخصية

​

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

📘 الوثائق الكاملة: واجهة برمجة التطبيقات للتحقق من صورة الهوية الشخصية →

​

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

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

• image_url: رابط صورة الهوية التي تحتاج إلى المعالجة.
• config: خيارات تكوين اختيارية، حقل قيمة منطقية، الافتراضي هو false، يدعم copy_warn، border_check_warn، reshoot_warn، detect_ps_warn، temp_id_warn، quality (عتبة 0-100).

{
  "sim": 99.76,
  "result": "Success",
  "description": "نجاح",
  "name": "اسم الهوية",
  "sex": "جنس الهوية",
  "nation": "أمة الهوية",
  "birth": "تاريخ ميلاد الهوية",
  "address": "عنوان السكن في الهوية",
  "id_num": "رقم الهوية",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}

• sim: درجة التشابه، تتراوح قيمتها بين [0.00، 100.00]. يُوصى بأن تكون درجة التشابه أكبر من أو تساوي 70 لتعتبر نفس الشخص، ويمكن تعديل العتبة وفقًا للسيناريو المحدد (معدل الخطأ عند عتبة 70 هو واحد من الألف، ومعدل الخطأ عند عتبة 80 هو واحد من عشرة آلاف).
• result: رمز خطأ العمل، في حالة النجاح يتم إرجاع “Success”، وفي حالة الخطأ يرجى الرجوع إلى قائمة رموز الأخطاء في قسم FailedOperation أدناه.
• description: هنا نتيجة التحقق من الاسم ورقم الهوية.
• name: معلومات الاسم في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• sex: معلومات الجنس في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• nation: معلومات الأمة في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• birth: معلومات تاريخ الميلاد في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• address: معلومات عنوان السكن في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• id_num: معلومات رقم الهوية في الهوية، إذا لم يتم تحميل صورة الهوية، ستكون فارغة.
• portrait: ترميز base64 لصورة الهوية، إذا فشلت عملية قص الصورة، سيتم استخدام الصورة الكاملة للهوية للمقارنة وإرجاع فارغ.
• warnings: معلومات التحذير، عندما يتم تكوين معلومات التحذير في التكوين، سيتوقف مقارنة الصورة، وسيتم إرجاع نتيجة خطأ (FailedOperation.OcrWarningOccurred) مع هذه المعلومات التحذيرية.
• quality: درجة جودة الصورة، عندما يتم تكوين تحذير ضبابية الصورة في الطلب، تكون هذه المعلمة ذات معنى، تتراوح قيمتها بين (0-100)، العتبة الافتراضية حاليًا هي 50، وأي قيمة أقل من 50 ستؤدي إلى تحذير ضبابية.
• encryption: معلومات تشفير البيانات الحساسة.

curl -X POST 'https://api.acedata.cloud/identity/idcard/check-1e' \
-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/check-1e"

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)

​

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

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

​

الخاتمة