Интеграции API¶

Для создания интеграций между платформой Telebreeze и сторонними приложениями вам понадобятся API-ключи. Откройте «Интеграции API» в меню учётной записи, затем выберите вкладку «Ключи API». Нажмите на ваше имя вверху справа и выберите соответствующий пункт в раскрывающемся списке:

Отдельные ключи создаются для разных пользователей. Ключ принадлежит пользователю, который его создал. В логах всегда можно будет посмотреть, что и когда пользователь изменил в платформе.

Чтобы создать новый ключ, выберите роль ключа, введите его название и нажмите "Создать ключ". Роль ключа накладывает на ключи все ограничения, связанные с одноимённой ролью пользователя.

Ключи располагаются в виде блоков со следующей информацией:

Название ключа. Название можно изменить, нажав на название ключа.
Сам ключ с кнопкой копирования ключа справа от него.
Разрешенные IP-адреса. По умолчанию ключом можно пользоваться с любого IP, но можно ограничить его использование с одного или нескольких IP-адресов. Чтобы ввести адрес, нажмите "Любой" в этой строке:

Введите адрес, нажмите "Добавить адрес", включите переключатель "Разрешить подключение с указанных IP-адресов" и сохраните.
Роль ключа (Оператор, Дилер или Владелец контента).
Кто создал: имя, дата, время создания ключа.

Чтобы удалить ключ, нажмите в правой части блока с ним на меню действий и выберите "Удалить ключ":

Встроенная справка API¶

В разделе интеграций также доступны вкладки Dashboard, Player, Authorization, Console, EPG, Search и Statistics. Выберите справку сервиса, с которым создаёте интеграцию. В ней представлены операции, схемы запросов и ответов, примеры и загрузка документа OpenAPI.

Используйте справку своей установки: пути запросов и схемы должны соответствовать её версии. В справке Dashboard на демо обмен API-ключа выполняется через POST /api/dashboard/auth/access-token и возвращает Bearer-токен; при обмене учитываются ограничения IP-адресов ключа. Не переносите этот способ авторизации на остальные сервисы без проверки их справки.

Кнопки Test Request отправляют реальные запросы. Просмотр примера сам по себе его не выполняет; перед запуском проверьте операцию и целевой сервер.

Жизненный цикл ключа¶

Храните ключ на серверной стороне интеграции, а не в браузерном приложении или публичном исходном коде. Согласно пояснению панели, при удалении владельца или роли связанный ключ удаляется. Для ключа действуют ограничения прав и IP-адресов. Действия через API проверяйте в журнале доступа.