دليل التكامل
المصادقة والبحث وقراءة النتائج.
1. المصادقة
اتصل من الخادم الخاص بك باستخدام مفتاح API ورؤوس Content-Type: application/json. حافظ على خصوصية مفتاحك.
افتح مفاتيح API2. طلب المعلمات
تدعم الطلبات الاستعلام والعد وsearch_lang فقط. يقبل الاستعلام سؤالاً باللغة الطبيعية أو كلمات رئيسية.
| الميدان | النوع | مطلوب | وصف |
|---|---|---|---|
| query | string | نعم | سؤال البحث أو الكلمات الرئيسية. يجب ألا تكون فارغة. |
| count | integer | لا | عدد النتائج المرغوبة. قم بحذف أو تمرير 0 لاستخدام الخدمة الافتراضية. |
| search_lang | string | لا | لغة البحث، على سبيل المثال zh-hans. تقوم الخدمة بتطبيع zh إلى zh-hans. انقر فوق هذا الصف للحصول على القائمة المدعومة. |
3. اتصل بالبحث API
POST
https://api.starsg.ai/api/product/websearch/searchاستبدل YOUR_API_KEY وقم بتعيين الاستعلام على نص البحث الخاص بك. العد وsearch_lang اختيارية.
curl -X POST 'https://api.starsg.ai/api/product/websearch/search' \
-H 'api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"query": "北京今天的天气",
"count": 5,
"search_lang": "zh-hans"
}'إرسال كائن JSON مباشرةً، بدون غلاف النص أو /v1. إضافي
4. اقرأ النتيجة
تحقق من النجاح أولا. عند النجاح، اقرأ data.references وdata.data؛ في حالة الفشل، قم بفحص errorCode وerrorMsg. محتوى الويب أدناه توضيحي.
استجابة النجاح
{
"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.
استجابة الخطأ
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}الأخطاء الشائعة والخطوات التالية
PARAM_INVALID | تحقق من JSON واستفسر. قم بتصحيح المعلمات قبل إعادة المحاولة. |
SEARCH_FAILED | فشل البحث. أعد المحاولة لاحقًا مع تحديد عدد المحاولات. بالنسبة لحالات الفشل المستمرة، قم بحفظ وقت الاتصال ومعرف طلب الدعم. |