راهنمای ادغام

احراز هویت، جستجو و خواندن نتایج.

1. احراز هویت

از سرور خود با api-key و هدر Content-Type: application/json تماس بگیرید. کلید خود را خصوصی نگه دارید

کلیدهای API را باز کنید

2. درخواست پارامترها

درخواست ها فقط از پرس و جو، شمارش و search_lang پشتیبانی می کنند. query یک سوال یا کلمات کلیدی به زبان طبیعی را می پذیرد.

میداننوعمورد نیازتوضیحات
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_INVALIDJSON و پرس و جو را بررسی کنید. قبل از تلاش مجدد، پارامترها را تصحیح کنید.
SEARCH_FAILEDجستجو شکست خورد. بعداً با محدودیت تلاش دوباره امتحان کنید. برای خرابی های مداوم، زمان تماس و درخواست شناسه برای پشتیبانی را ذخیره کنید.