الانتقال إلى المحتوى الرئيسي
ستقدم هذه الوثيقة شرحًا عن كيفية تكامل API للتحقق من ثلاثة عناصر رقم الهاتف، والذي يمكن استخدامه للتحقق من صحة وتوافق رقم الهاتف، الاسم ورقم الهوية.

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

لاستخدام API، يجب أولاً الذهاب إلى API للتحقق من ثلاثة عناصر رقم الهاتف وتقديم طلب الخدمة المناسبة، بعد الدخول إلى الصفحة، انقر على زر “Acquire”، كما هو موضح في الصورة: إذا لم تكن قد قمت بتسجيل الدخول أو التسجيل بعد، سيتم تحويلك تلقائيًا إلى صفحة تسجيل الدخول لدعوتك للتسجيل وتسجيل الدخول، بعد تسجيل الدخول والتسجيل، سيتم العودة تلقائيًا إلى الصفحة الحالية. عند التقديم لأول مرة، سيكون هناك حد مجاني متاح، يمكنك استخدام هذا API مجانًا.

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

أولاً، يجب أن نفهم طريقة الاستخدام الأساسية، وهي إدخال رقم الهاتف، للحصول على النتيجة المعالجة، يجب أولاً تمرير حقل phone. بعد ذلك، يمكننا ملء المحتوى المناسب في الواجهة، كما هو موضح في الصورة:

يمكنك أن ترى أننا قمنا بتعيين رؤوس الطلب، بما في ذلك:
  • accept: الشكل الذي ترغب في تلقي استجابة النتائج به، هنا يتم ملؤه بـ application/json، أي بتنسيق JSON.
  • authorization: مفتاح استدعاء API، بعد التقديم يمكنك اختياره مباشرة من القائمة المنسدلة.
كما تم تعيين جسم الطلب، بما في ذلك:
  • name: اسم المستخدم الذي يحتاج إلى المعالجة، وهو حقل مطلوب.
  • phone: رقم الهاتف الذي يحتاج إلى المعالجة، وهو حقل مطلوب.
  • id_card: رقم هوية المستخدم الذي يحتاج إلى المعالجة، وهو حقل مطلوب.
  • verify_mode: وضع التحقق (طويل/قصير).
  • encrypt_list/ciphertext_blob/iv: معلمات تشفير اختيارية، لتشفير الحقول الحساسة حسب الحاجة.
بعد الاختيار، يمكنك أن تلاحظ أن الكود المقابل تم إنشاؤه على الجانب الأيمن، كما هو موضح في الصورة:

انقر على زر “Try” لإجراء الاختبار، كما هو موضح في الصورة أعلاه، هنا حصلنا على النتيجة التالية:
{
  "result": "0",
  "description": "认证通过",
  "isp": "移动",
  "result_detail": null
}
تتضمن النتيجة العائدة عدة حقول، كما هو موضح أدناه:
  • result: رمز نتيجة التحقق، حالة الرسوم كما يلي.
    • رموز نتائج الرسوم:
      • 0: نتيجة التحقق متطابقة
      • 1: نتيجة التحقق غير متطابقة
    • رموز النتائج غير المدفوعة:
      • -1: لا توجد سجلات
      • -2: خطأ غير معروف في المحرك
      • -3: خدمة المحرك غير طبيعية
      • -4: فشل التحقق من الاسم
      • -5: رقم الهاتف غير قانوني
      • -6: تجاوز عدد مرات التحقق الحد اليومي، يرجى المحاولة مرة أخرى في اليوم التالي
  • description: وصف نتيجة العمل.
يمكنك أن ترى أن معلومات صحة وتوافق رقم الهاتف، الاسم ورقم الهوية قد تم استعلامها. بالإضافة إلى ذلك، إذا كنت ترغب في إنشاء كود التكامل المقابل، يمكنك نسخه مباشرة، على سبيل المثال، كود CURL كما يلي:
curl -X POST 'https://api.acedata.cloud/identity/phone/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "phone": "***",
  "id_card": "***"
}'
كود التكامل بلغة Python كما يلي:
import requests

url = "https://api.acedata.cloud/identity/phone/check-3e"

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

payload = {
    "name": "***",
    "phone": "***",
    "id_card": "***"
}

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

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

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

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

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

الخاتمة

من خلال هذه الوثيقة، لقد تعرفت على كيفية استخدام API للتحقق من ثلاثة عناصر رقم الهاتف للتحقق من صحة وتوافق رقم الهاتف، الاسم ورقم الهوية. نأمل أن تساعدك هذه الوثيقة في تكامل واستخدام هذا API بشكل أفضل. إذا كان لديك أي استفسارات، فلا تتردد في الاتصال بفريق الدعم الفني لدينا.