Перейти к содержимому
Продукты

HTTP API

В Alta есть HTTP API с запросами и ответами в формате JSON. С его помощью можно создавать каналы, подключать входные потоки, управлять хранилищами архива и контролем доступа, а также читать состояние сервиса из биллинга, мидлвара или скриптов.

Веб-интерфейс Alta использует тот же API, поэтому всё, что можно сделать в интерфейсе, можно автоматизировать.

Все запросы отправляются на API Server, а не на OTT Server, который обслуживает зрителей. Порт по умолчанию: 8100. Подробнее в разделе HTTP-сервер.

http://alta.example.com:8100/api/...

Каждый запрос, кроме /api/login, требует учётные данные пользователя Alta. Есть два способа:

  • Bearer token: получите токен через POST /api/login и передавайте его в заголовке Authorization: Bearer <token>.
  • HTTP Basic: передавайте логин и пароль пользователя в каждом запросе.

Подробнее в разделе Быстрый старт.

Роль пользователя определяет, что разрешает API. Роли задаются в разделе Пользователи.

РольДоступ
adminВсе запросы этого раздела
observerТолько чтение: Состояние приложения и хоста, ресиверы (GET, состояние), хранилище канала, превью и экспорт M3U
anonymousНет доступа. Каждый запрос возвращает 401

Любой вошедший пользователь может прочитать свои параметры и сменить свой пароль. См. Пользователи.

  • Передавайте тело запроса в формате JSON с заголовком Content-Type: application/json.
  • Запрос одного элемента использует параметр id в строке запроса, например /api/ott/receiver?id=news-hd.
  • Идентификаторы канала и варианта содержат слеш, например discovery/hd. Передавайте слеш как есть или в URL-кодировке %2F.
  • POST создаёт элемент, PUT заменяет его, DELETE удаляет. Запрос PUT заменяет все поля элемента. Передавайте объект целиком, а не только изменённые поля.
  • Успешный запрос, который изменяет данные, возвращает 204 No Content с пустым телом. Alta сохраняет конфигурацию до ответа.
  • В Alta нет запросов, которые возвращают списки каналов, ресиверов или хранилищ. Чтобы получить идентификаторы элементов, используйте запросы состояния, например состояние ресиверов, состояние хранилищ и состояние сессий.
КодОписание
200Успешно, с телом ответа
204Успешно, либо у элемента нечего возвращать, например у канала без хранилища
400Не указан параметр id или запрос некорректен. В теле может быть причина в виде простого текста
401Нет учётных данных или они неверны
403Роль пользователя не разрешает запрос. Неверный логин или пароль для /api/login
404Элемент не существует
409Элемент уже существует, либо ресивер уже используется другим каналом
422Значение поля недопустимо
500Alta не смогла сохранить конфигурацию
РазделЧто можно сделать
Быстрый стартВойти и опубликовать первый канал
СостояниеПрочитать версию, время работы, нагрузку CPU, память и место на диске
КаналыСоздавать, изменять, запускать, останавливать и удалять каналы, экспортировать плейлисты M3U
РесиверыУправлять входными потоками и импортировать каналы из плейлиста M3U
ХранилищаУправлять хранилищами архива и читать их размер
Preview APIСкачивать MP4-превью из архива
АвторизаторыУправлять правилами доступа и генерировать значения Securetoken
СессииУзнать, кто смотрит сейчас
Доступ по HLSИзменить длительность сегмента и размер плейлиста
ПользователиУправлять пользователями и паролями