Документация

Документация FrameRelay

Настройка воркспейса, подготовка сети и работа с API. Текущая версия 2.14.3.

Обзор

В воркспейсе FrameRelay хранятся ваши проекты, люди и медиа. Внутри проекта можно открывать live-комнаты, загружать и раздавать файлы и синхронизировать папки между рабочими станциями с помощью агента.

Воркспейсы доступны только по приглашениям. Чтобы войти, вас должен кто-то пригласить или должна быть одобрена ваша заявка на доступ.

Вход в воркспейс

  1. Откройте письмо с приглашением и скопируйте код. Он выглядит как FR-7K2Q-91XD и действует 7 дней.
  2. Перейдите на framerelay.xyz/ru/invite и введите код.
  3. Подтвердите почту. Дальше вход идёт по одноразовой ссылке, так что пароль забыть не получится.
Потеряли приглашение или оно истекло? Попросите администратора воркспейса отправить новое в разделе «Настройки → Люди».

Десктоп-приложение и агент

Десктоп-приложение запускает live-комнаты и управляет загрузками. Вместе с ним ставится агент синхронизации — фоновый сервис, который стартует вместе с системой и держит одно соединение с ближайшим узлом.

  • macOS 12 и новее, Apple silicon или Intel
  • Windows 10 или 11, x64 или ARM64
  • Ubuntu 22.04+, Debian 12+, Fedora 39+

Участники воркспейса после входа могут скачать его на странице загрузки. Обновления ставятся автоматически в фоне.

Сетевые требования

FrameRelay нужен только исходящий TCP 443. Разрешите на файрволе студии следующие хосты:

ХостПортПротоколДля чего
framerelay.xyz443HTTPSВеб-приложение, вход, инвайты
static.framerelay.xyz443HTTPSСкрипты, шрифты, картинки
api.framerelay.xyz443HTTPSАвторизация, проекты, комментарии, события
edge.framerelay.xyz443TLS 1.3 поверх TCPLive-комнаты, соединение агента
cdn.framerelay.xyz443HTTPSЗагрузки, скачивания, ссылки на просмотр

Инспекция TLS

Десктоп-приложение и агент проверяют сертификаты FrameRelay (certificate pinning). Если файрвол расшифровывает и переподписывает TLS-трафик, соединения с edge.framerelay.xyz и cdn.framerelay.xyz не установятся. Добавьте все пять хостов в исключения инспекции.

Долгие соединения

Соединения с edge держатся часами, иногда сутками, и по ним идёт ровный поток данных. Выставьте таймауты простоя на шлюзах и NAT не меньше 60 минут. Агент шлёт heartbeat каждые 30 секунд, так что рабочее соединение никогда не простаивает по-настоящему.

IP-адреса edge-узлов могут меняться при расширении мощностей. Разрешайте доступ по имени хоста, а не по IP.

Гайд по трафику

Live-комнаты подстраиваются под самого медленного рецензента. Ориентируйтесь на эти цифры на одно соединение:

СценарийОбычноПик
Live-комната, 4K 10-bit25–35 Мбит/с50 Мбит/с
Live-комната, 1080p 10-bit8–12 Мбит/с18 Мбит/с
Звук и камера рецензента0,5–1,5 Мбит/с2,5 Мбит/с
Агент синхронизации, активный проект20–200 ГБ/деньВаш лимит
Агент синхронизации, простой<1 МБ/час—

Чтобы ограничить агент, откройте «Настройки → Трафик» и добавьте расписание. Лимиты действуют на каждую рабочую станцию отдельно.

Обзор API

REST API позволяет автоматизировать проекты, загрузки и ссылки на просмотр. Все запросы идут на:

https://api.framerelay.xyz/v2

Запросы и ответы в JSON. Время в ISO 8601, UTC. В каждом ответе есть заголовок x-request-id — указывайте его при обращении в поддержку.

Авторизация

Создайте токен в разделе «Настройки воркспейса → API». Токен привязан к одному воркспейсу и может быть только для чтения.

curl https://api.framerelay.xyz/v2/projects \
  -H "Authorization: Bearer fr_live_••••••••••••"

Запросы без действующего токена получают 401:

{ "error": "unauthorized", "message": "Missing or invalid bearer token" }

Методы

МетодПутьОписание
GET/v2/projectsСписок проектов воркспейса
GET/v2/projects/:id/assetsСписок файлов проекта
POST/v2/uploadsНачать загрузку с докачкой, возвращает адреса частей на cdn
POST/v2/review-linksСоздать подписанную ссылку на просмотр
DELETE/v2/review-links/:idОтозвать ссылку на всех узлах
GET/v2/roomsСписок активных live-комнат
GET/v2/eventsПоток событий воркспейса (SSE)

Лимиты запросов

Каждый токен может делать 600 запросов в минуту. Сверх лимита приходит 429 с заголовком Retry-After. Загрузка частей файлов на cdn.framerelay.xyz в лимит не входит.

Вебхуки

Укажите HTTPS-адрес в разделе «Настройки воркспейса → Вебхуки». Мы отправляем события asset.ready, comment.created, room.started, room.ended и link.viewed. Каждый запрос подписан HMAC-SHA256 в заголовке x-fr-signature.

# проверка подписи вебхука
expected = hmac_sha256(secret, timestamp + "." + raw_body)