دليل التكامل

المصادقة والبحث وقراءة النتائج.

1. المصادقة

اتصل من الخادم الخاص بك باستخدام مفتاح API ورؤوس Content-Type: application/json. حافظ على خصوصية مفتاحك.

افتح مفاتيح API

2. طلب المعلمات

تدعم الطلبات الاستعلام والعد وsearch_lang فقط. يقبل الاستعلام سؤالاً باللغة الطبيعية أو كلمات رئيسية.

الميدانالنوعمطلوبوصف
querystringنعمسؤال البحث أو الكلمات الرئيسية. يجب ألا تكون فارغة.
countintegerلاعدد النتائج المرغوبة. قم بحذف أو تمرير 0 لاستخدام الخدمة الافتراضية.

4. اقرأ النتيجة

تحقق من النجاح أولا. عند النجاح، اقرأ data.references وdata.data؛ في حالة الفشل، قم بفحص errorCode وerrorMsg. محتوى الويب أدناه توضيحي.

استجابة النجاح
json
{
  "success": true,
  "data": {
    "references": [
      {
        "website": "example.com",
        "logo": "https://example.com/favicon.ico",
        "title": "مثال أخبار المنزل الذكي",
        "url": "https://example.com/article",
        "summary": "ملخص نتائج البحث يذهب هنا.",
        "published": "",
        "extra": {}
      }
    ],
    "data": [
      "ملخص نتائج البحث يذهب هنا."
    ]
  },
  "errorCode": null,
  "errorMsg": null
}
data.referencesمراجع الويب مع العناوين والروابط والملخصات.
data.dataقائمة نصية للنتيجة، متداخلة داخل كائن البيانات الخارجي.
references[].website / logoاسم موقع الويب أو المجال والشعار URL.
references[].title / url / summaryعنوان النتيجة والصفحة الأصلية URL والملخص.
references[].published / extraتاريخ النشر ومعلومات إضافية. قد تكون فارغة.

success=true مع مراجع فارغة ومصفوفات بيانات يعني عدم العثور على نتائج صالحة. جرب كلمات رئيسية مختلفة أو لغة بحث مختلفة؛ لا تعامله على أنه فشل API.

استجابة الخطأ
json
{
  "success": false,
  "data": null,
  "errorCode": "PARAM_INVALID",
  "errorMsg": "query is required"
}

الأخطاء الشائعة والخطوات التالية

PARAM_INVALIDتحقق من JSON واستفسر. قم بتصحيح المعلمات قبل إعادة المحاولة.
SEARCH_FAILEDفشل البحث. أعد المحاولة لاحقًا مع تحديد عدد المحاولات. بالنسبة لحالات الفشل المستمرة، قم بحفظ وقت الاتصال ومعرف طلب الدعم.