Streaming Hub API: обзор и подготовка

Какую документацию выбрать

• Создаёте приложение, подключающееся к Core — используйте раздел Streaming Hub API.
• Создаёте автоматизации в графическом приложении — откройте документацию Streaming Hub Editor.
• Разрабатываете действия, сигналы или интеграции внутри Core — используйте Plugin SDK.

Клиенту не нужны WPF, поставляемый Editor, внутреннее устройство Core или Plugin SDK. Закрытие клиента не останавливает Core. Тема, расположение панелей и неотправленные черновики принадлежат вашему приложению.

Выберите способ подключения

API использует HTTP с авторизацией по пути /api/v1 и ограниченные потоки WebSocket. Сейчас поддерживаются локальные приложения Windows: Core слушает 127.0.0.1 на динамически выделенном порту. Запросы из браузера и подключения по локальной сети не поддерживаются.

Протокол можно использовать из любого языка с HTTP-клиентом. Примеры PowerShell показывают формат запросов; для .NET доступны библиотеки StreamingHub.Api.Client и StreamingHub.Api.Contracts, обе для .NET 8. Клиент проверяет обнаружение, выполняет pairing, согласует сеанс и предоставляет типизированные контракты и средства наблюдения.

HTTP API v1, версия Core, версии пакетов Client/Contracts и версия Host Plugin API обозначают разные вещи. Используйте Client и Contracts из одного проверенного набора. Публичный источник NuGet сейчас не заявлен.

Подготовьте Core

Используйте совместимый пакет Core с Tray для подтверждения доступа и откройте копию тестового проекта. Оставьте Tray доступным: внешнему клиенту требуется разрешение пользователя.

В локальной копии репозитория с .NET 8 SDK сначала соберите решение, затем запустите Core:

dotnet build Streaming-HUB.slnx
dotnet run --project StreamingHub.CoreHost -- --data-dir C:\StreamingHubApiTest --project C:\StreamingHubApiTest\Test.shubproj

Сначала создайте тестовую папку и копию проекта. Отдельная папка данных изолирует настройки, профили, состояние плагинов, учётные данные и обнаружение; при этом для одного пользователя Windows по-прежнему разрешён только один Core. Завершите работу существующего Core, прежде чем запускать другую тестовую установку. В готовом пакете Core запускается через StreamingHub.CoreHost.exe и включает Tray.

Найдите адрес Core

Если отдельная папка данных не задана, файл обнаружения находится здесь:

%LOCALAPPDATA%\StreamingHub\runtime\api-discovery.json

При использовании --data-dir откройте api-discovery.json в указанной папке. Файл содержит endpoint, hostInstanceId и apiMajorVersions. После перезапуска Core прочитайте его заново: порт и идентификатор Host могут измениться. Доступ к файлу обнаружения сам по себе не даёт разрешения на доступ к Core.

Порядок работы клиента

1. Прочитайте данные обнаружения и проверьте локальный адрес и основную версию HTTP API.
2. Запросите разрешения и выполните pairing через Tray пользователя.
3. Обменяйте подтверждённые учётные данные на сеанс и выполните handshake.
4. Прочитайте согласованный снимок состояния, затем следите за изменениями.
5. Отправляйте команды с привязкой к идентификатору и ревизии; при неизвестном результате используйте исходные ID для восстановления.

Для изменения и сохранения проекта используйте операции API. Не перезаписывайте напрямую активный файл проекта и связанные файлы данных.