Руководство по интеграции

Аутентификация, поиск и чтение результатов.

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Поиск не удался. Повторите попытку позже с ограничением количества попыток. В случае постоянных сбоев сохраните время звонка и идентификатор запроса для поддержки.