Общий порядок подключения
Для отправления запросов к поисковой базе Яндекса с помощью сервиса Yandex Search API вам понадобится сервисный аккаунт.
Перед началом работы
Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:
- Перейдите в консоль управления
, затем войдите в Yandex Cloud или зарегистрируйтесь. - На странице Yandex Cloud Billing
убедитесь, что у вас подключен платежный аккаунт, и он находится в статусеACTIVE
илиTRIAL_ACTIVE
. Если платежного аккаунта нет, создайте его.
Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака
Подробнее об облаках и каталогах.
Подготовьте сервисный аккаунт
Создайте сервисный аккаунт
-
Войдите в консоль управления
. -
Нажмите на строку с именем каталога, в котором вы хотите создать сервисный аккаунт.
-
В верхней части экрана перейдите на вкладку Сервисные аккаунты.
-
Нажмите кнопку Создать сервисный аккаунт.
-
Введите имя сервисного аккаунта.
Требования к формату имени:
- длина — от 3 до 63 символов;
- может содержать строчные буквы латинского алфавита, цифры и дефисы;
- первый символ — буква, последний — не дефис.
Имя сервисного аккаунта должно быть уникальным в рамках облака.
-
Нажмите кнопку Создать.
Назначьте роль
Чтобы сервисный аккаунт мог отправлять запросы, ему понадобится роль работы с сервисом Search API. Назначьте сервисному аккаунту роль search-api.executor
:
- В консоли управления
выберите нужный каталог. - Перейдите на вкладку Права доступа.
- Нажмите кнопку Назначить роли.
- В открывшемся окне нажмите
Выбрать пользователя → Сервисные аккаунты. - Выберите нужный сервисный аккаунт из списка или воспользуйтесь поиском.
- Нажмите кнопку
Добавить роль. - Выберите роль в каталоге.
- Нажмите кнопку Сохранить.
Создайте API-ключ
Для аутентификации в сервисе Search API сервисному аккаунту понадобится API-ключ. Создайте API-ключ для сервисного аккаунта:
- В консоли управления
перейдите в каталог, которому принадлежит сервисный аккаунт. - В верхней части экрана перейдите на вкладку Сервисные аккаунты.
- Выберите сервисный аккаунт и нажмите на строку с его именем. При необходимости создайте новый сервисный аккаунт.
- На панели сверху нажмите кнопку
Создать новый ключ и выберите пункт Создать API-ключ. - Задайте описание ключа, чтобы потом было проще найти его в консоли управления.
- Нажмите кнопку Создать.
- Сохраните идентификатор и секретный ключ.
Внимание
После закрытия диалога значение ключа будет недоступно.
Для подключения и использования сервиса Search API выполните следующие действия:
Регистрация
- В консоли управления
выберите каталог, в котором вы будете работать с Search API, или создайте новый. - Перейдите в сервис Search API.
- Заполните поля формы:
- Выберите Тип поиска —
Русский
,Турецкий
илиМеждународный
. - Задайте как минимум один IP-адрес, с которого вы будете отправлять запросы к поисковой базе Яндекса.
- Выберите Тип поиска —
- Нажмите кнопку Сохранить.
Позже вы сможете изменить регистрационные данные.
Создайте тестовый запрос
-
В рабочем каталоге откройте сервис Search API.
-
Перейдите на вкладку Тестирование запросов.
-
Выберите Метод запроса (поддерживаются методы GET и POST) и заполните поля формы.
Примечание
В тестовом запросе нельзя изменить Текст поискового запроса. Запросы отправляются с IP-адреса Яндекса от имени сервиса.
-
Нажмите Запустить тест. Результат выполнения запроса появится ниже.
-
При необходимости измените параметры, чтобы скорректировать результаты выдачи, и повторите отправку запроса.
Настройте интеграцию с Search API
- Узнайте об особенностях аутентификации в Yandex Cloud и настройте отправку запросов.
- Настройте обработку ответа с учетом формата ответа.
- При необходимости запросите информацию о часовых ограничениях на ближайшие сутки.