Связаться с намиПодключиться

Общий порядок подключения

Статья создана
Обновлена 1 ноября 2024 г.

Для отправки запросов к поисковой базе Яндекса с помощью сервиса Yandex Search API через интерфейс API v1 вам понадобится сервисный аккаунт.

Чтобы настроить сервис Search API для использования через API v1, выполните следующие действия:

Перед началом работы

Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:

  1. Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь.
  2. На странице Yandex Cloud Billing убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его и привяжите к нему облако.

Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака.

Подробнее об облаках и каталогах.

Подготовьте сервисный аккаунт

Создайте сервисный аккаунт

  1. Войдите в консоль управления.

  2. В левой части экрана нажмите на строку с именем каталога, в котором вы хотите создать сервисный аккаунт.

  3. В списке сервисов выберите Identity and Access Management.

  4. Нажмите кнопку Создать сервисный аккаунт.

  5. Введите имя сервисного аккаунта.

    Требования к формату имени:

    • длина — от 3 до 63 символов;
    • может содержать строчные буквы латинского алфавита, цифры и дефисы;
    • первый символ — буква, последний — не дефис.

    Имя сервисного аккаунта должно быть уникальным в рамках облака.

  6. Нажмите кнопку Создать.

Назначьте роль

Чтобы сервисный аккаунт мог отправлять запросы к сервису Search API через API v1, назначьте ему роль search-api.executor:

  1. В консоли управления выберите каталог.
  2. Перейдите на вкладку Права доступа.
  3. Нажмите кнопку Настроить доступ.
  4. В открывшемся окне выберите раздел Сервисные аккаунты.
  5. Выберите сервисный аккаунт из списка или воспользуйтесь поиском.
  6. Нажмите кнопку Добавить роль и выберите роль в каталоге.
  7. Нажмите кнопку Сохранить.

Создайте API-ключ

Для аутентификации в API v1 Search API сервисному аккаунту понадобится API-ключ. Создайте API-ключ для сервисного аккаунта:

  1. В консоли управления перейдите в каталог, которому принадлежит сервисный аккаунт.
  2. В списке сервисов выберите Identity and Access Management.
  3. На панели слева выберите Сервисные аккаунты.
  4. Выберите сервисный аккаунт, для которого вы хотите создать API-ключ. При необходимости создайте новый сервисный аккаунт.
  5. На панели сверху нажмите кнопку Создать новый ключ и выберите пункт Создать API-ключ.
  6. Задайте описание ключа, чтобы потом было проще найти его в консоли управления.
  7. (Опционально) Выберите Область действия. Подробнее про области действия см. в разделе API-ключи с ограничениями области и срока действия.
  8. (Опционально) Укажите Срок действия.
  9. Нажмите кнопку Создать.
  10. Сохраните идентификатор и секретный ключ.

Внимание

После закрытия диалога значение ключа будет недоступно.

Регистрация

Чтобы использовать интерфейс API v1, необходимо зарегистрироваться в сервисе Search API:

  1. В консоли управления выберите каталог, в котором вы будете работать с Search API, или создайте новый.

  2. В списке сервисов выберите Search API.

  3. Заполните поля формы:

    • Выберите Тип поиска — Русский, Турецкий или Международный.

    • Задайте как минимум один доверенный IP-адрес, с которого вы будете отправлять запросы к поисковой базе Яндекса.

      Отправлять запросы к API v1 сервиса Search API можно только с одного из IP-адресов, добавленных в настройки сервиса при регистрации. При попытке выполнить запрос с незарегистрированного IP-адреса этот запрос будет отклонен.

  4. Нажмите кнопку Сохранить.

Позднее вы сможете изменить тип поиска и список доверенных IP-адресов. Для этого в консоли управления перейдите в сервис Search API и в правом верхнем углу экрана нажмите Редактировать.

Создайте тестовый запрос

Чтобы в интерактивном режиме познакомиться с принципом формирования поискового запроса к API v1 сервиса Search API, воспользуйтесь специальной формой тестирования запроса:

  1. В консоли управления выберите каталог, в котором вы будете работать с Search API.

  2. В списке сервисов выберите Search API.

  3. На панели слева выберите Тестирование запросов.

  4. Выберите Метод запроса (поддерживаются методы GET и POST) и заполните поля формы.

    Примечание

    В тестовом запросе нельзя изменить Текст поискового запроса. Запросы отправляются с IP-адреса Яндекса от имени сервиса.

    По мере изменения значений в полях формы в поле Поисковый запрос будет формироваться URL поискового запроса, соответствующего заданным значениям. Если выбран метод запроса POST, в поле Тело запроса также будет формироваться соответствующее тело запроса.

  5. Нажмите Запустить тест. Результат выполнения запроса появится ниже.

  6. При необходимости измените параметры, чтобы скорректировать результаты выдачи, и повторите отправку запроса.

Настройте интеграцию с Search API

  1. Узнайте об особенностях аутентификации в API v1 и настройте отправку запросов.
  2. Настройте обработку ответа с учетом формата ответа в XML или HTML.
  3. При необходимости запросите информацию о часовых ограничениях на ближайшие сутки.
Предыдущая
Все инструкции
Следующая
Тестирование запросов