Оформление
Подключения VK Ads и Авито Рекламы через REST
Передавайте токен проекта в X-SN-TOKEN. Пути начинаются с /public/api/v1/manage. Как получить доступ у площадки, описано в инструкциях VK Ads и Авито Рекламы.
Получить список, прочитать и удалить подключение
Для VK Ads используйте базовый путь /vk-ads-integrations, для Авито Рекламы — /avito-ads-integrations. У списков нет параметров query.
| Запрос | Пример результата |
|---|---|
GET / | 200 OK, массив подключений. Пустой результат — []. |
GET /{id} | 200 OK, объект выбранного подключения. |
DELETE /{id} | 204 No Content. |
Для чтения и удаления используйте UUID подключения из id. Числовой ID рекламного аккаунта относится к площадке.
Создать или обновить подключение VK Ads
В POST /vk-ads-integrations передайте name, clientId и clientSecret или accessToken по выбранному способу доступа. Например, тело запроса с секретом приложения выглядит так.
json
{
"name": "Demo VK Ads",
"clientId": "YOUR_VK_CLIENT_ID",
"clientSecret": "YOUR_VK_CLIENT_SECRET"
}Чтобы обновить название, вызовите PUT /vk-ads-integrations/{id} с новым name и текущим clientId. Пропустите поля секретов, чтобы использовать сохранённые значения. GET для одного подключения, POST и PUT возвращают сам объект. Ниже пример части ответа.
json
{
"id": "60132ea9-a885-46f2-9062-548ac4a56ee4",
"name": "Demo VK Ads",
"clientId": "YOUR_VK_CLIENT_ID",
"hasClientSecret": true,
"isRenewable": true
}Создать или обновить подключение Авито Рекламы
В POST /avito-ads-integrations передайте name, clientId (Client Key), clientSecret и числовой avitoAccountId. Ниже пример с вымышленными реквизитами.
json
{
"name": "Demo Avito Ads",
"clientId": "YOUR_AVITO_CLIENT_KEY",
"clientSecret": "YOUR_AVITO_CLIENT_SECRET",
"avitoAccountId": 12345
}Чтобы сменить название, передайте {"name":"Demo Avito Ads Europe"} в PATCH /avito-ads-integrations/{id}. Пропущенные поля сохраняют значения. Для переданных полей требуется значение, явный null отклоняется. POST и PATCH возвращают entity. GET для одного подключения возвращает тот же объект напрямую.
json
{
"entity": {
"id": "041bb17c-dbd8-49fe-bcb7-99e7561483ae",
"name": "Demo Avito Ads",
"avitoAccountId": 12345,
"hasClientSecret": true
}
}Проверить доступ и исправить ошибки
Успешный ответ подтверждает сохранённое подключение. Перед использованием статистики проверьте нужный рекламный аккаунт и состояние авторизации. API показывает наличие секретов, а их значения остаются скрыты.
При ошибке авторизации проекта проверьте X-SN-TOKEN. Если подключение не найдено, сверьте его UUID и проект. При ошибке прав площадки или входных данных прочитайте ответ API управления и проверьте реквизиты и ID аккаунта в кабинете площадки.