Начало работы

Scopes

Какие права (scopes) нужны OAuth-приложению для каждого метода API DonateX.

Scopes ограничивают, что OAuth-приложение может делать от имени стримера. Запрашивайте только нужные — стример видит их на экране согласия. External token работает без scopes и имеет полный доступ.

Если токену не хватает права, API ответит 403 Forbidden. Нужный scope указан у каждого метода в документации.

Доступные scopes

donations.read

Чтение истории донатов, топа донатеров, активной цели и текущего трека.

GET /v1/donationsGET /v1/goals/currentGET /v1/top-donatorsGET /v1/music/current

donations.write

Управление алертами и музыкой: тестовые донаты, скипы, очистка очереди и повтор доната.

POST /v1/test-donationPOST /v1/donations/skip-currentPOST /v1/donations/{id}/skipPOST /v1/donations/skip-allPOST /v1/donations/{id}/rerunPOST /v1/music/skip-current

donations.subscribe

Подписки на вебхуки и подключение к realtime-хабу.

/v1/webhooks/subscriptionsSignalR /api/public-donations-hub

user.read

Профиль стримера и его ИИ-персонажи.

GET /v1/user/meGET /v1/ai/charactersGET /v1/ai/characters/{id}

offline_access

Выдача refresh_token, чтобы обновлять доступ без повторного входа пользователя.

POST /api/connect/token

openid

OIDC-идентификатор пользователя в токене.

profile

Имя пользователя и аватар в токене.

Авторизация

Дальше

Ошибки