Просмотреть исходный

Общий подход

Common API поддерживает следующие объекты верхнего уровня (некоторые из них являются необязательными).

ID	Описание
`campaigns`	Кампании
`campaign_groups`	Группы кампаний
`creatives`	Креативы
`sites`	Сайты
`segment_definitions`	Общие сегменты
`reference_tables`	Содержит дополнительную информацию и различные настройки
`domains_lists`	Общие списки доменов
`snippets`	Сниппеты

Метод

Метод	Описание
`all`	Выбрать все объекты
`list`	Список объектов
`get`	Получить информацию об объекте
`new`	Создать новый объект
`edit`	Обновить объект
`delete`	Удалить объект

Переменные

Все методы API используют следующие обязательные переменные:

Переменная	Описание
<entity>	Тип объекта (reference_tables, segment_definitions, ...)
<entity_id>	ID объекта
<token>	Токен для доступа к API. Это значение можно найти в меню пользователя «Мои настройки»

Примеры

Выбрать все объекты

GET https://ui.getintent.com/api/v2/<entity>/all?token=<token>

Ответ:

{
    "data": {
       "<entity id>" => {<entity data>},
       ...
    }
}

Список объектов

GET https://ui.getintent.com/api/v2/<entity>/list?token=<token>&custom_fields=<field1>,<field2>,...

Ответ:

{
    "data": {
       "<entity id>" => {<entity data>},
       ...
    }
}

Использование "list" по умолчанию возвращает только поля «id» и «name» объекта, дополнительные поля в выводе контролируются параметром «custom_fields».

Создать объект

Используйте тип запроса PUT, тело запроса должно содержать соответствующий объект JSON.

PUT https://ui.getintent.com/api/v2/<entity>/new?token=<token>

Пример:

curl --data '{"name": "title",...}' -H 'Content-Type: application/json' -X PUT https://ui.getintent.com/api/v2/<entity>/new?token=<token>

Выбрать атрибуты объекта

GET https://ui.getintent.com/api/v2/<entity>/get/<entity_id>?token=<token>

Пример:

curl -X GET https://ui.getintent.com/api/v2/<entity>/get/<entity_id>?token=<token>

Обновить объект

Используйте тип запроса PUT, тело запроса должно содержать соответствующий объект JSON.

PUT https://ui.getintent.com/api/v2/<entity>/edit/<entity_id>?token=<token>

Пример:

curl --data '{"name": "new title",...}' -H 'Content-Type: application/json' -X PUT https://ui.getintent.com/api/v2/<entity>/edit/<entity_id>?token=<token>

Удалить объект

DELETE https://ui.getintent.com/api/v2/<entity>/delete/<entity_id>?token=<token>

Пример:

curl -X DELETE https://ui.getintent.com/api/v2/<entity>/delete/<entity_id>?token=<token>

Ограничения размера файла JSON

В настоящее время API платформы Getintent имеет ограничение 3 МБ для каждого файла JSON кампании. Успешная обработка файлов большего размера не гарантируется.