TAŇBA-OOH Разработчикам

Подключение CMS

Коммерческая CMS может управлять конструкциями TAŇBA-OOH после сертификации по профилю CMS (уровни C1 и C2). В этом руководстве три вызова, которые она делает, и правило, которое нельзя нарушать. Полный перечень требований дан в документе профиля CMS.

Один раз зарегистрировать в консоли

Администратор организации оператора делает это в разделе «Интеграции»:

  1. Регистрирует источник подписи для установки (название, вид и открытый ключ ECDSA P-256 системы CMS). Один источник обслуживает одну установку.
  2. Регистрирует установку: источник, номер сертификата сертифицированного продукта, используемую версию, базовый адрес и заявление о месте размещения.
  3. Сопоставляет каждый плеер CMS с одной конструкцией и привязывает конструкции к установке.
  4. Создает ключ API с правом relay:commands и, для показов, write:plays.

Получать подписанные команды

curl 'https://app.tanba-ooh.kz/api/v1/cms/commands?installation=5d0c8e7a-21b4-4c3f-9a6e-0b1d2c3e4f50&wait=30' \
  -H 'Authorization: Bearer tnbk_EXAMPLE_secret'

Вызывайте в цикле с wait=30 или по вебхуку device_command.issued. В каждой записи команда, конструкции, к которым она относится, и подписанный конверт. Платформа уже проверила конверт по корням команд; CMS тоже должна его проверять. Выполните команду на плеерах каждой указанной конструкции в течение 60 секунд после получения и подтвердите каждую конструкцию:

curl -X POST 'https://app.tanba-ooh.kz/api/v1/cms/commands/01a1377e-c8e3-7c41-8ae9-3a8dc9413fbd/acks?installation=5d0c8e7a-21b4-4c3f-9a6e-0b1d2c3e4f50' \
  -H 'Authorization: Bearer tnbk_EXAMPLE_secret' -H 'Content-Type: application/json' \
  -d '{"structure": "ALM-0012", "ok": true, "state": "blackout"}'

Неподтвержденная команда выдается повторно через 5 минут и считается неудавшейся после третьей попытки. Платформа показывает результат как переданный через ретранслятор и не проверенный на устройстве.

Ключ switch принадлежит органу

Отключение пишет в ключ плеера switch значение blackout, восстановление пишет default, аварийная трансляция или переключение контента пишут имя сценария. Писать switch может только код, который выполняет команды ретранслятора. Никакая другая функция CMS (возобновление, пауза, публикация, собственное затемнение или авария, перезапуск) не вправе писать его или снимать затемнение. CMS, которая это делает, не сертифицируется.

Передавать показы

Показы идут по каналу подписанных пакетов, POST /api/v1/pop/batches, с правом write:plays и подписью ключом источника установки. Формат пакета описан в справочнике по подтверждению показов. Такие показы аттестованные: их сообщила система оператора и подписала, на устройстве они не наблюдались.