Быстрый старт

Краткое руководство по интеграции MADS API. Полная спецификация в справочнике API.

Шаг 1. Создайте плейсмент

Создайте плейсмент в кабинете паблишера и получите padId — идентификатор рекламного слота. Подробнее: Базовая инструкция для паблишеров.

Шаг 2. Запросите рекламу

Базовый URL для запросов (API_BASE_URL)

https://mads-serve.magnit.ru

Вызовите эндпоинт получения рекламы:

curl -X GET "[API_BASE_URL]/v1/ads/get?padId={YOUR_PAD_ID}&userId={USER_ID}"

Обязательные параметры:

• padId — идентификатор плейсмента
• userId — идентификатор пользователя (для персонализации и статистики)

Полный список параметров: Получение рекламных форматов · Справочник API

Шаг 3. Обработайте ответ и отобразите рекламу

При статусе 200 в ответе приходят:

• templateGroupName - формат рекламы (modalwindow, multiformat, stories и др.)
• displayOptions - настройки отображения
• items - массив креативов (изображения, видео, кнопки)
• statistics - URL для отправки событий показа и клика

Отобразите рекламу согласно формату. Структура данных зависит от templateGroupName:

Полные модели: Модели данных · Справочник API

Коды ответа

При статусе, отличном от 200, не отображайте рекламу или покажите заглушку.

Шаг 4. Отправьте события

После показа рекламы вызовите URL из statistics с типом impression. После клика — URL с типом click.

Подробнее: Отправка взаимодействия с рекламой

Дальше

• Полный справочник API — эндпоинты, параметры, схемы
• API рекламной платформы — описание эндпоинтов
• Модели данных — структура ответа