Выберите правильную версию API

Текущее приложение использует API /app/api/v1. Старые интеграции могут использовать отдельный сервис api.screenapp.io/v2. Их эндпоинты, учетные данные и процесс загрузки не взаимозаменяемы.

Прежде чем менять существующую интеграцию, определите ее базовый URL и поколение аккаунта. Для старой интеграции используйте справочник v2 и уточните у ScreenApp поддержку миграции.

Создайте ключ в текущем приложении

Откройте Settings > API в текущем приложении. Создайте ключ с понятным названием и минимально нужными правами и сохраните его, когда он будет показан. Храните ключ в секрете и отзовите его, если он попал в чужие руки. Проверьте, к личному или командному пространству относится ключ.

Текущие публичные права доступа: files:read and files:upload.

Получите данные аккаунта

Задайте SCREENAPP_API_KEY в переменных окружения. Не вставляйте ключ в клиентский HTML и не коммитьте его в репозиторий.

curl --fail-with-body "https://screenapp.io/app/api/v1/me"   -H "x-api-key: $SCREENAPP_API_KEY"

Загрузите файл

Используйте ключ с правом загрузки. Замените имя локального файла своим.

curl --fail-with-body "https://screenapp.io/app/api/v1/videos"   -H "x-api-key: $SCREENAPP_API_KEY"   -F "file=@recording.mp4"

Ответ содержит идентификатор нового файла. Обработка продолжается в фоне. Опрашивайте GET /app/api/v1/videos/{id}, пока transcriptStatus не станет ready, затем запросите GET /app/api/v1/videos/{id}/transcript.

Прямые загрузки через текущий API ограничены размером тела запроса 512 MB. Это ограничение только для API; у загрузок в приложении нет установленного ограничения размера файла. Тот же эндпоинт videos принимает JSON-объект с публичным url вместо загрузки локального файла.

Чтение записей

GET /app/api/v1/videos возвращает список записей в пространстве ключа.
GET /app/api/v1/videos/{id} возвращает статус и метаданные.
GET /app/api/v1/videos/{id}/transcript возвращает расшифровку, когда она готова.

Для этих запросов нужно право чтения. Отсутствующий или неверный ключ возвращает 401, недостаточные права возвращают 403, превышение лимита запросов возвращает 429. Если передан Retry-After, соблюдайте его. Запрос расшифровки до ее готовности может вернуть 409.

Встраивание рекордера

Встраивание настраивается отдельно и ограничено доменами. Следуйте инструкции по встраиванию рекордера. Не используйте приватный REST-ключ как токен встраивания.

Эти примеры описывают текущий контракт API. Проверьте их в нужном аккаунте и окружении, прежде чем заменять работающую старую интеграцию.