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

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

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

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

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

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

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

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

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

payload = {
    "name": "***",
    "mobile": "***"
}

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

​
الخاتمة

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