README.md

Peka2.tv API

Текущая версия

0.X.X

История изменений

Общее

Запрос посылается методом POST для основного апи и через Websocket для чата, если не указано иного. Параметры запроса в JSON формате, протокол HTTP.
Авторизация происходит через токен в Header. Например

POST /api/user/current HTTP/1.1
Token: Bearer your-token-here

Успешный ответ приходит со статусом 200.
При ошибке ответ приходит со статусом 500. Формат ответа ошибки

{
    message: string; // Текст ошибки
}

Для описания параметров используется формат TypeScript интерфейсов и типов.
Параметры отмеченные ? являются необязательными. Если параметр является объектом и указан без ? но его ключи указаны как необязательные, то подразумевается что нужно передать хотя бы один из них внутри объекта.
Где написано объект из ответа ..., если не указано иного, подразумевает ответ указанного запроса без необязательных параметров/опций.

Запросы передаются на сайт http://peka2.tv для общего API и на wss://chat.peka2.tv для чата.

Примеры запросов на curl

curl -H "Content-Type: application/json" -H "Accept: application/json; version 1.0" -X POST http://peka2.tv/api/user/current
curl -H "Content-Type: application/json" -H "Accept: application/json; version 1.0" -H "Token: Bearer ..." -X POST -d '{content: "stream"}' http://peka2.tv/api/subscribe/subscribers

В случае вопросов, ошибок или неточностей документации, пишите в Помощь на сайте funstream.tv (необходимо залогиниться, категория 'Технические вопросы') или в Мейн чат на сайте peka2.tv пользователю drow.

API

Права доступа

• P Публичный, авторизация не обязательна
• A Все авторизованные пользователи
• M Модераторы, роль moderator
• S Саппорты, роль support
• B Администратор блокировок, роль blocker
• Sm Администратор смайлов, роль smiler
• MS Стример с партнёркой, роль masterstreamer
• RA Администратор ролей, роль roleAdmin
• StA Администратор магазина, роль storeAdmin
• StS Поддержка магазина, роль storeSupport
• C Закрытый, для внутреннего использования

---

• OAuth
  • POST A /api/oauth/app Получить данные приложения
  • POST A /api/oauth/app/set Сохранить данные приложения
  • POST P /api/oauth/check Проверка статуса кода
  • POST P /api/oauth/exchange Получить токен по коду
  • POST A /api/oauth/grant Предоставить доступ по коду
  • POST P /api/oauth/request Запросить код
• Чат
  • Протокол взаимодействия
    • Примеры взаимодействия для разных языков
  • Оповещение сервера
    • WS P /chat/login Подписаться на события пользователя
    • WS A /chat/logout Отписаться от событий пользователя
    • WS P /chat/join Присоединится к каналу
    • WS P /chat/leave Покинуть канал
    • WS P /chat/history История канала
    • WS A /chat/publish Отправить сообщение
    • WS P /chat/channel/list Список пользователей в канале
  • Оповещение клиента
    • WS P /chat/message Новое сообщение
    • WS P /chat/message/remove Удаление сообщения
  • Каналы чата
  • Типы сообщений
• Общее
  • Пользователь
    • POST P /api/user Данные пользователя
    • POST P /api/user/list Данные списка пользователей
    • POST P /api/user/current Данные текущего пользователя
    • POST RA /api/user/full Полные данные пользователя
    • POST C /api/user/login Логин
    • POST P /api/user/login/bytoken Логин по токену
    • POST P /api/user/logout Логаут
    • POST A /api/user/settings Получить или установить настройки текущего пользователя
    • POST P /api/user/forgot Запрос на сброс пароля
    • POST P /api/user/restore Установка пароля
    • POST RA /api/user/roles/list Список пользователей с ролью
    • POST RA /api/user/roles/set Изменить роль пользователя
  • Категория
    • POST P /api/category Категория контента
  • Стрим
    • POST P /api/stream Данные стрима
  • Чат
    • POST P /api/channel/data Данные каналов
    • POST P /api/channel/private Список приват каналов
  • Фильтр
    • POST A/P /api/content Список элементов контента
    • POST P /api/content/top Топ N элементов контента
  • Подписки
    • POST A /api/subscribe/add Подписаться
    • POST A /api/subscribe/amount Количество активных подписок онлайн
    • POST A /api/subscribe/check Проверить подписку
    • POST A /api/subscribe/list Список подписок
    • POST A /api/subscribe/remove Отписаться
    • POST A /api/subscribe/subscribers Список подписчиков пользователя
  • Игноры
    • POST A /api/ignore/add Добавить в список игнорируемых
    • POST A /api/ignore/check Проверить на игнор
    • POST A /api/ignore/list Список игнорируемого
    • POST A /api/ignore/remove Удалить из списка игнорируемого
  • Дополнительные вызовы
    • POST P /api/bulk Пакетный запрос
• Смайлы
  • Смайлы
    • POST P /api/smile Доступные смайлы
    • POST MS/Sm /api/smile/add Добавить смайл
    • POST Sm /api/smile/approve Утвердить изменения в смайлах стримера
    • POST Sm /api/smile/pending Список изменений в смайлах стримеров на утверждение
    • POST Sm /api/smile/reject Отклонить изменения в смайлах стримера
    • POST MS/Sm /api/smile/remove Удалить смайлы
    • POST MS/Sm /api/smile/update Обновить смайлы
    • POST MS /api/smile/ms/pending Наличие смайлов в ожидании утверждения
    • POST MS /api/smile/ms/prepare Отправить текущие изменения в смайлах на утверждение
    • POST MS /api/smile/ms/revert Откатить изменения в смайлах
  • Иконки
    • POST Ms /api/icon/add Добавление иконки
    • POST P /api/icon/list Список иконок
    • POST Ms /api/icon/remove Удаление иконок
• Магазин
  • Бонусы
    • Типы бонусов и их параметры
    • POST StA /api/store/bonus/modify Создание/изменение бонуса
    • POST StA /api/store/bonus/list Список бонусов
  • Бонусы пользователя
    • POST StS /api/store/purchase/list Список бонусов пользователя
    • POST A /api/store/purchase/my Список бонусов текущего пользователя
    • POST StS /api/store/purchase/remove Удалить бонус пользователя
    • POST StS /api/store/purchase/modify Изменение данных бонуса пользователя
    • POST A/StS /api/store/purchase/setStatus Изменение статуса бонуса пользователя
  • Покупка бонуса
    • POST A /api/store/buy/pekoins Покупка бонуса за пекоины
    • POST A /api/store/buy/points Покупка бонуса за баллы
  • Баллы
    • POST StS /api/store/points/get Баллы пользователя
    • POST A /api/store/points/my Баллы текущего пользователя
    • POST StS /api/store/points/set Изменить баллы пользователя
  • Подписки на стримеров
    • POST A /api/store/subscription/purchase Купить подписку на стримера
    • POST StS /api/store/subscription/list Список подписок пользователя
    • POST A /api/store/subscription/my Список подписок текущего пользователя
    • POST StS /api/store/subscription/modify Добавление/изменение подписки пользователя
    • POST StS /api/store/subscription/remove Удаление подписки пользователя
    • POST A/StS /api/store/subscription/setStatus Изменение статуса подписки
  • Уведомления
    • bonus/purchase Куплен/добавлен бонус
    • bonus/points Изменился баланс баллов
    • bonus/subscription Изменилась/добавилась подписка
• Платежи
  • Уведомления
    • payment/stream Донат на стрим
• Плеер
  • GET P /api/player/live Онлайн статус трансляций
• Админка
  • Модерация
    • POST A /api/moderation/accuse Забанить пользователя
    • POST B /api/moderation/block Блокировка пользователя
    • POST P /api/moderation/check Проверить забанен ли пользователь
    • POST A /api/moderation/list Получить список банов
    • POST P /api/moderation/reasons Получить список причин бана
    • POST M /api/moderation/undo Отменить бан
  • Поддержка
    • POST A /api/support/ask Задать вопрос
    • POST A /api/support/ban Отключить возможность задавать вопросы
    • POST A /api/support/channels Список последних вопросов
    • POST S /api/support/list Получить список вопросов
  • Безопасность
    • POST A /api/security/user Список последних логинов
  • Уведомления
    • chatBan Бан в чате
    • chatBanAttempt Отметка о нарушении в чате
    • chatBanUndo Отмена бана в чате
• Уведомления
  • Событие уведомления
  • Прочие уведомления
    • Сторонние сервисы в чате
      • chatThirdpartySendMessageError Ошибка отправки сообщения в чат сервис
• Сторонние сервисы
  • POST C /api/oauth/thirdparty/register Регистрация через сторонние сервисы
  • Уведомления
    • thirdpartyLogin Логин через сторонние сервисы
    • thirdpartyRegister Регистрация через сторонние сервисы

Спасибо @JAremko за помощь в оформлении документации.