Руководство разработчика ОРД

• Регистрация объектов
• Модификация ранее зарегистрированных объектов
• Получение (выгрузка) зарегистрированных объектов
• Регистрация новых и модификация данных по существующим объектам в ЕРИР
• Загрузка медиафайлов креативов в хранилище ОРД
• Назначение и выдача маркера (токена)
• Получение статуса объектов
• Возобновление незавершенного процесса регистрации или обновления объекта

• Предварительную валидацию объекта и его запись (регистрацию) в хранилище ОРД;
• Только для креативов: загрузку медиафайлов в хранилище ОРД;
• Регистрацию объекта в ЕРИР.

Модификация объектов

• Предварительную валидацию объекта и его модификацию в хранилище ОРД
• Только для креативов и только при необходимости: загрузку медиафайлов в хранилище ОРД
• Модификацию объекта в ЕРИР

Получение (выгрузка) зарегистрированных объектов

Загрузка медиафайлов креативов в хранилище ОРД

• Клиент

• ОРД

• Клиент

- Публичный доступ во внутреннее хранилище ОРД закрыт.

- При обновлении данных допускается указывать внутреннюю ссылку, которая была ранее создана для данного креатива. Не допускается указывать ссылки, созданные в других креативах.

Назначение и выдача маркера (токена)

• Для успешно зарегистрированного объекта (в статусе APPROVED) маркер всегда присутствует в статусной информации;
• В ряде случаев для ускорения процесса маркер может появится ранее, например, с началом регистрации в ЕРИР, а не по ее окончании.

Получение статуса объектов

• В заголовках HTTP в ответах на запросы любых типов к объектам ОРД
• В теле ответа на запросы:    

POST, PUT и GET /{entityType}/{entityId}/status

Возобновление незавершенного процесса регистрации или обновления объекта

POST /{entityType}/{entityId}/sync

Основной статус

Выбор сценария

• Синхронная обработка обычно используется по умолчанию.
• В случае нештатных ситуаций синхронный процесс завершается и переключается в асинхронный. К таким ситуациям относятся:

Диаграмма сценариев (для случая регистрации нового объекта)

• В случае успеха или перманентной ошибки объект переходит в статус APPROVED или DECLINED соответственно и обработка данного объекта в системе завершается (в общем случае до модификации объекта).
• В прочих случаях объект остается в статусе PENDING и производится определенное число повторных попыток
• При исчерпании количества повторных попыток объект переходит в статус DECLINED

• До завершения успешной загрузки медиаданных отправка данных в ЕРИР производиться не будет и сущность будет иметь статус PENDING.
• Загрузка медиаданных происходит в соответствии со статусной моделью media-state (см. выше).

• Передача данных в ОРД

• Периодический опрос статуса по каждому объекту, регистрация которого не завершена (GET /{entityType}/{entityId}/status)
• Получение и анализ уведомлений об изменении статуса через сервис Simple Message Notification (SMN)
• Периодическое возобновление процесса по каждому объекту, регистрация которого не завершена
• Получение маркера креатива (если регистрируются креативы)

• Анализ нештатных и ошибочных ситуаций и совершение по ним определенных действий

• ОРД оставляет за собой право отключить синхронный сценарий (см. Сценарии регистрации и модификации объектов) для креативов, также как и для других объектов, в зависимости от нагрузки на систему и договоренностей с ЕРИР;
• Отказ от объекта при отсутствии токена в синхронном ответе и повторная регистрация напрямую ведет к дублированию данных, что является плохой практикой и в общем случае не поддерживается. Это может быть предметом вопросов со стороны оператора ЕРИР, а также может приводить к завышенной сумме в счете за услугу;

Регистрация нового объекта

• Вызвать метод POST /{entityType}
• Проанализировать response code

• Вызвать метод GET /{entityType}/{entityId}/status
• Проанализировать значение state в ответе

Модификация ранее созданного объекта

• Вызвать метод PUT /{entityType}/{entityId}
• Проанализировать response code

• Вызвать метод GET /{entityType}/{entityId}/status
• Проанализировать значение state в ответе

• Осуществление вызовов HTTP REST GET, POST, PUT, опционально HEAD
• Прием и передача JSON
• Анализ HTTP статус кода ответа
• Возможность разбора ответа в формате JSON при любом статус-коде
• Возможность анализа заголовков в ответе HTTP

API Authorisation header

Authorization: Bearer ABCDE.ZYXWV

• У Клиента должен быть подключен сервис SMN
• На стороне Клиента должен быть выделен SMN topic для сообщений от ОРД
• К этому SMN topic должен быть дан доступ на публикацию сообщений технологической учетной записи ОРД

• Имя файла формируется из данных HTTP заголовка Content-Disposition, либо из суффикса URL
• Тип файла формируется из HTTP заголовка Content-Type, либо из суффикса имени файла

Составные HTML креативы

Видео креативы (VAST и VPAID)

• Ссылка mediaUrl должна указывать на объект в формате VAST или VAST Wrapper
• При загрузке VAST итеративно загружаются компоненты креатива, которые описывает VAST (непосредственно сами ролики или VPAID компоненты), поэтому все они также должны быть доступны для ОРД на время регистрации креативаВведите текст