Библиотеки
В GitHub StreamVi есть библиотеки для запросов к API, подключения через OAuth и оформления интерфейса плагина. Выбирайте библиотеку под задачу:
| Задача | Библиотека | Что она делает |
|---|---|---|
| Запросы к API в проекте с Axios | SDK Axios | Типизированные методы, параметры и ответы API |
| Запросы к API через Fetch | SDK Fetch | Типизированный клиент на встроенном fetch |
| OAuth в приложении с Passport | Passport | Стратегия Node.js с проверкой state и PKCE |
| Интерфейс React-плагина | UI Kit | Компоненты, светлая и тёмная темы |
Две версии SDK решают одну задачу. Обычно достаточно одной; отличаются транспорт, обработка ошибок и формат результата. Passport выполняет подключение, после которого токен можно передать выбранному SDK. UI Kit отвечает за внешний вид и не получает доступ к API.
С чего начать
Сначала выберите тип плагина, создайте приложение и задайте разрешения нужных методов. Для внешнего сервера получите токен по инструкции OAuth; для виджета используйте параметры запуска. Секрет приложения не передавайте в браузер.
Наличие метода в SDK не выдаёт разрешение на его вызов. Токен интеграции используется для /method/ и привязан к проекту. Методы кабинета /site/, которые тоже могут присутствовать в сгенерированной библиотеке, требуют другой авторизации. Контракт конкретного метода проверяйте в справочнике API.
SDK и UI Kit устанавливаются из основной ветки GitHub. Сохраните package-lock.json, чтобы зафиксировать установленные зависимости. Требования к окружению и история изменений находятся в репозиториях библиотек. Для нового OAuth-подключения начните с серверного примера с PKCE; установка исправленного Passport описана на его странице.
Готовые примеры
В разделе Примеры описаны OAuth-приложение и счётчик зрителей с обновлением через WebSocket. Там же находятся ссылки на серверные примеры внутри обоих SDK.