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

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

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

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

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

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

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

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

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

payload = {
    "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"
}

​
الخاتمة

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