> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/api/ru/publichnyi-api-exoclick/api-dlya-razrabotchikov.md).

# API для разработчиков

С помощью API платформы можно автоматизировать все функции, которые доступны в панели администратора.

<details>

<summary>1. Что могут автоматизировать рекламодатели?</summary>

* Кампании/группы, вариации, офферы и рекламные форматы
* Таргетинг/блокировка параметров таргетинга, категорий
* Цели
* Получение статистики, включая данные пользователей adblock
* Дневной бюджет, пополнение счёта, способы оплаты
* Название лендинга, URL и алгоритм распределения трафика

</details>

<details>

<summary>2. Что могут автоматизировать паблишеры?</summary>

* Рекламные форматы и рекламные зоны
* Сайты, проверки URL
* Блокировка типов рекламы и категорий продуктов
* Получение всей статистики, включая данные пользователей adblock
* Ставки по рекламному формату/GEO, модели ценообразования
* Способы оплаты

</details>

<details>

<summary>3. Как использовать API</summary>

* Интерфейс API быстрый и удобный в использовании
* Просто выберите параметр и нажмите кнопку **Попробовать** «Попробовать» для автоматической генерации кода

</details>

<details>

<summary>4. Скачать техническую документацию</summary>

* [PHP-клиент](https://github.com/exads/exads-api-client-php)

</details>

## Как использовать API платформы

Мы только что обновили API нашей платформы до версии 2. Эта последняя версия позволяет вам автоматизировать абсолютно все функции внутри панели администратора. Вы можете использовать API для простых процессов, например автоматизации повторяющихся задач, чтобы сэкономить время, а также для более сложных проектов, например изменения креативов баннеров на лету.

### Функции

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

#### Рекламодатели

* Отдельные/групповые кампании, вариации, офферы, рекламные форматы.
* Таргетинг/блокировка параметров таргетинга, категорий, разделение по времени суток.
* Цели.
* Получение статистики, включая данные пользователей adblock.
* Дневной бюджет, пополнение счёта, способы оплаты.
* Название лендинга, URL и алгоритм распределения трафика.

#### Паблишеры

* Рекламные форматы и рекламные зоны.
* Сайты, проверки URL.
* Блокировка типов рекламы и категорий продуктов.
* Получение всей статистики, включая данные пользователей adblock.
* Ставки по рекламному формату/GEO, модели ценообразования.
* Способы оплаты.

**Перед началом**

Интерфейс API показывает список названий групп. Нажмите на группу, и раскроются все доступные параметры.

![список API](/files/cac2a0170c8936550edc495d459d180bcc02b025)

### HTTP-методы

API поддерживает следующий набор HTTP-методов. Обратите внимание, что не все функции поддерживают все методы.

![Использование API](/files/b74128452ac2bf77350b85818634ec1ce1967ba3)

Давайте начнём!

### Настройка

Чтобы получить доступ к защищённым API-запросам, должен быть установлен Session Token. Чтобы создать токен, у вас должен быть действующий аккаунт.

Создание API-токена доступно в вашем **Мой профиль** меню. Выберите API-токены.

![мой профиль](/files/c37b588707aa9a2468d6dcd244595a1a661e142d)

Нажмите на **Новый API-токен**.

![API-токены](/files/0fff805f400da0f2714bdbe60aa2b504ca39e44f)

Введите имя токена; в этом руководстве мы назвали наш «testToken», затем нажмите **Сохранить**.

Идентификатор токена создан.

![ID токена](/files/eb191c53299732d88ba6bd0dc56b2ea31e1f8a13)

### Вход в API

В интерфейсе API нажмите на **Вход** кнопку в правом верхнем углу экрана и введите имя пользователя и пароль либо предоставьте API-токен. Нажмите **Отправить** и в API будет отправлен запрос на вход для получения действительного session token. Затем этот токен будет использоваться для подтверждения всех API-запросов, которые вы захотите сделать в течение сессии.

![вход в API](/files/58433af941511d18a973aa2abe343a64f4eb1e0f)

![вход в API](/files/c70ab7ede7a623809d307074a17b8d62d70e8064)

### Как отправить запрос в API

Давайте рассмотрим пример группы Campaigns: нажмите на неё, и группа раскроется, показывая доступные запросы:

Нажмите на запрос, который вы хотите автоматизировать; в этом примере мы запросим данные для CID 1923724, используя:

![получить кампанию](/files/aa04c20c40be3722f28115f5f96c1b617d5143be)

Нажмите на **Получить кампанию** после чего окно раскроется. Введите номер ID кампании в поле:

![ID кампании](/files/ab43c197b91559f80f451e885f5a3633354502e5)

Затем нажмите на **Попробовать сейчас** кнопку. Тело ответа автоматически сгенерирует код.

![тело ответа](/files/86826d351482a3c41dd35af74d0b04fd4e80a4e0)

Код ответа 200 означает, что всё в порядке и можно использовать.

### Как приостановить кампанию

Вот ещё один пример. Сначала выберите нужную функцию из группы Campaigns:

![пауза кампании](/files/cc15d899bd133966b74cd5add5784dfa99983777)

Нажмите на **Приостановить** для одной или нескольких кампаний. После открытия нажмите Example Value, затем нажмите на жёлтое поле — это автоматически вставит JSON-структуру в поле body.

![пауза](/files/826f4c0c1b3e5f6fd75ce7bd4ecb24c2b31f11fa)

Теперь текущее значение равно нулю, поэтому замените ноль на CID, который вы хотите поставить на паузу. Затем нажмите **Попробовать** кнопку, чтобы сгенерировать нужный код.

![ID кампании](/files/08b1432e6f65ac7d6691fa28a5ec45011528e1ca)

### Как обновить цену кампании

Выберите правильную функцию:

![ID кампании](/files/4ada04bcb75ede6bf9dd715b3334e2011726b400)

Нажмите на **Обновить кампанию**, чтобы открыть окно. Добавьте CID в поле ID кампании, затем нажмите Example Value, нажмите на жёлтое поле, которое скопирует JSON-структуру в поле body.

Этот код содержит несколько разных функций, но нам нужен код цены кампании, поэтому удалите ненужную часть кода, оставив в поле код цены кампании, как показано ниже:

![ID кампании](/files/4d006d9e34ace180814a9a3ae84a01080f550615)

Теперь нам нужно изменить два значения в поле body: model (ниже приведён список значений, соответствующих модели ценообразования).

```
CampaignPricing {
model (integer, optional): модель ценообразования кампании (1: CPC, 2: CPM, 3: CPA, 4: Smart CPM, 5: CPV) = [‘1’, ‘2’, ‘3’, ‘4’, ‘5’],
price (number, optional): цена кампании
}
```

Мы оставим CPC, поэтому оставим model равным 1

Теперь нам нужно изменить цену с нуля на нужную нам. Мы изменим её на 200, что означает, что новая цена будет 200 центов или два евро.

![ID кампании](/files/91d440d8aaefcb8dcb6bfcd1c4cfd967b4769199)

Затем просто нажмите **Попробовать** кнопку, чтобы сгенерировать код. Легко!

Как видите, API наполнен функциями для автоматизации; единственный предел — это ваше воображение, чтобы раскрыть силу автоматизации.

И наконец, обязательно подпишитесь на нашу API-рассылку, которую вы найдёте внизу интерфейса API, чтобы получать последние новости и обновления.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.exoclick.com/api/ru/publichnyi-api-exoclick/api-dlya-razrabotchikov.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
