Введение
Программный интерфейс к службе Яндекс Вебмастер (далее API Яндекс Вебмастера) дает возможность разработчикам создавать приложения для работы с пользовательскими данными, хранящимися на сервисе Яндекс Вебмастер.
Например, с помощью API Яндекс Вебмастера вы можете дать возможность вашим пользователям получать и редактировать списки своих сайтов, добавлять новые сайты, узнавать статус подтверждения сайта, статистику его индексирования и др.
Примерами возможных приложений являются:
- создание надстройки Яндекс Вебмастера к панели управления сайтом хостинговой компании;
- создание приложений для управления сайтами.
Также вы можете использовать PHP-класс для работы с API Вебмастера 3.0. Он совместим с версиями 3.1 и 3.2, но без поддержки Турбо-страниц и ИКС (индекс качества сайта).
Как работает API
API Яндекс Вебмастера реализовано на REST-принципах (Representational State Transfer) с использованием HTTP и JSON/XML для обмена данными.
Клиентское приложение обменивается JSON/XML-сообщениями с сервером API Яндекс Вебмастера посредством HTTP-запросов в соответствии с REST-принципами: ресурсы сайтов и списков сайтов получаются методом HTTP GET, создаются методом HTTP POST и удаляются методом HTTP DELETE, см. Обзор ресурсов API.
API Яндекс Вебмастера доступен для идентифицированных пользователей по адресу:
https://api.webmaster.yandex.net/
По умолчанию API возвращает JSON. Для получения XML-ответов, в запросах к ресурсам необходимо указывать специальный HTTP-заголовок:
Accept: application/xml
Запросы к API могут содержать параметры двух типов:
- Path-параметры — параметры, являющиеся частью URL ресурса.
- Query-параметры — параметры, добавленные к URL ресурса после знака ?.
Так как большинство действий в API Яндекс Вебмастера выполняется от имени конкретного пользователя, клиентское приложение должно быть авторизовано.
Кроме этого, при обращении к ресурсам API необходимо указывать ID пользователя. Его можно получить в начале работы с помощью вызова ресурса user.
Условия использования API
Чтобы начать работу с API Яндекс Вебмастера, компания-партнер должна заключить с Яндексом соглашение в установленной форме и получить client_id в системе авторизации Яндекса oauth.yandex.ru. Без client_id использование API невозможно.
При регистрации новой учетной записи партнера на сервере oauth.yandex.ru требуется указать следующие данные:
- Название приложения — название, которое будет показываться пользователям при запросе доступа к личным данным.
- Доступ к операциям (в настоящий момент это добавление сайта и получение информации о сайте).
- Иконка клиентского приложения.
- Ссылка на клиентское приложение.
- Callback URI — ссылка на страницу, куда пользователь будет перенаправляться после того, как подтвердит доступ к своим данным. Доступна при выборе типа платформы.
Использование API для написания пользовательских клиентских приложений подразумевает принятие Условий использования сервиса «API Яндекс Вебмастер». Действия клиентского приложения не должны противоречить правилам, установленным в этом документе.
Для выполнения действий с сайтами и списками сайтов, требующих обязательной авторизации, конечный пользователь клиентского приложения должен согласиться с пользовательским соглашением службы Яндекс Вебмастер. Клиентское приложение должно явно информировать его о такой необходимости.