---
metadata:
  - name: generator
    content: Diplodoc Platform v5.44.0
alternate:
  - en/
  - ru/
keywords:
  - w
  - e
  - b
  - m
  - a
  - s
  - t
  - r
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/webmaster/doc/ru/llms.txt


# Введение


{% note info "" %}

Вы открыли документацию API версии 4.1. Подробно: [Как работать с версиями API](https://yandex.ru/dev/webmaster/doc/ru/concepts/versions.md).

{% endnote %}

Программный интерфейс к службе Яндекс Вебмастер (далее _API Яндекс Вебмастера_) дает возможность разработчикам создавать приложения для работы с пользовательскими данными, хранящимися на сервисе Яндекс Вебмастер.

Например, с помощью _API Яндекс Вебмастера_ вы можете дать возможность вашим пользователям получать и редактировать [списки своих сайтов](https://yandex.ru/dev/webmaster/doc/ru/reference/hosts.md), добавлять новые [сайты](https://yandex.ru/dev/webmaster/doc/ru/reference/hosts-id.md), узнавать статус подтверждения сайта, статистику его индексирования и др.

Примерами возможных приложений являются:

- создание надстройки Яндекс Вебмастера к панели управления сайтом хостинговой компании;

- создание приложений для управления сайтами.

## Как работает API {#how-api-works}

_API Яндекс Вебмастера_ реализовано на _REST_-принципах ([Representational State Transfer](http://ru.wikipedia.org/wiki/REST)) с использованием HTTP и JSON/XML для обмена данными.

Клиентское приложение обменивается JSON/XML-сообщениями с сервером API Яндекс Вебмастера посредством HTTP-запросов в соответствии с REST-принципами: ресурсы сайтов и списков сайтов получаются методом HTTP GET, создаются методом HTTP POST и удаляются методом HTTP DELETE, см. [Обзор ресурсов API](https://yandex.ru/dev/webmaster/doc/ru/concepts/getting-started.md).

API Яндекс Вебмастера доступен для идентифицированных пользователей по адресу:

```
https://api.webmaster.yandex.net/
```

Запросы к API могут содержать параметры двух типов:

- Path-параметры — параметры, являющиеся частью URL ресурса.

- Query-параметры — параметры, добавленные к URL ресурса после знака ?.


{% note alert %}

При обмене данными между клиентским приложением и службой Яндекс Вебмастер всегда используйте кодировку _UTF-8_.

{% endnote %}


Так как большинство действий в API Яндекс Вебмастера выполняется от имени конкретного пользователя, клиентское приложение должно быть [авторизовано](https://yandex.ru/dev/webmaster/doc/ru/tasks/how-to-get-oauth.md).

Кроме этого, при обращении к ресурсам API необходимо указывать ID пользователя. Его можно получить в начале работы с помощью вызова ресурса [user](https://yandex.ru/dev/webmaster/doc/ru/reference/user.md).

#### Узнайте больше

- [How to Create a REST Protocol](https://www.xml.com/pub/a/2004/12/01/restful-web.html)

- [Building Web Services the REST Way](http://www.xfront.com/REST-Web-Services.html)


## Формат обмена данными {#format}

Запросы к API выполняются по протоколу HTTPS. По умолчанию сервис возвращает данные в формате JSON. Чтобы получить XML-ответ, передайте в запросе HTTP-заголовок `Accept: application/xml`.


## Условия использования API {#eula}

Для начала работы с API Яндекс Вебмастера необходимо [зарегистрировать приложение](https://yandex.ru/dev/webmaster/doc/ru/tasks/how-to-get-oauth.md) и получить `client_id`.

Использование API для написания пользовательских клиентских приложений подразумевает принятие [Условий использования сервиса «API Яндекс Вебмастер»](http://legal.yandex.ru/webmaster_api/). Действия клиентского приложения не должны противоречить правилам, установленным в этом документе.

Для выполнения действий с сайтами и списками сайтов, требующих обязательной [авторизации](https://yandex.ru/dev/webmaster/doc/ru/tasks/how-to-get-oauth.md), конечный пользователь клиентского приложения должен согласиться с пользовательским соглашением службы Яндекс Вебмастер. Клиентское приложение должно явно информировать его о такой необходимости.