Секретный токен donation alerts для чего
Перейти к содержимому

Секретный токен donation alerts для чего

  • автор:

Почему получаю ошибку Security token is invalid для donation alerts?

API_KEY и APP_ID указаны на странице https://www.donationalerts.com/application/clients после регистрации приложения.
Токен: настройки аккаунта — Секретный токен — показать.
Или в разделе «оповещения» — показать ссылку для встраивания, после знака равно. Они идентичны.

С ними невозможно накосячить, так как я их копирую, а не вбиваю вручную.
Токен актуальный, т.к. донаты приходят и отображаются в ОБС с текущим токеном в ссылке виджета.

По тому же токену открывается виджет в браузере с донатами по ссылке

https://www.donationalerts.com/widget/lastdonations?alert_type=1,4,13,15,11,16,14,2,3,5,12&limit=50&token=GNujomvS8KxSAQZiuQmw

Вот и не понимаю, откуда ошибка о неверном токене.
Может есть ещё какой-то токен?

Единственное — не смог получить refresh_token со страницы https://www.donationalerts.com/oauth/token (Страница не найдена)

Есть ли способ получить данные о донатах не через API а через ссылку

https://www.donationalerts.com/widget/lastdonations?alert_type=1,4,13,15,11,16,14,2,3,5,12&limit=50&token=GNujomvS8KxSAQZiuQmw?

гет запросы не работают, данные подгружаются динамически через джава скрипт.

import requests import webbrowser from urllib.parse import urlencode API_KEY = '9qqLIoNFGEctIaFWfPqWwDBOtVQ6sIHr2F0zPlKe' APP_ID = 66666 token = 'GNujomvS8KxSAQZiuQmw' REDIRECT_URI = 'http://127.0.0.1:49803/login' SCOPE = 'oauth-user-show oauth-donation-index' data = url = 'https://www.donationalerts.com/oauth/authorize?' + urlencode(data) webbrowser.open(url) code = input('code: ') data = r = requests.post('https://www.donationalerts.com/oauth/token', data=data).json() access_token = r[token] refresh_token = r['refresh_token'] headers = '.format(access_token)> response = requests.get('https://www.donationalerts.com/api/v1/alerts/donations', headers=headers) r = response.json() print(r)
  • Вопрос задан 07 авг. 2023
  • 229 просмотров

2 комментария

Простой 2 комментария

DonationAlerts — сервис для сбора донатов

В сети легко найти истории успеха стримеров, которые транслируют прохождение популярных видеоигр, учат или играют в свое удовольствие на музыкальных инструментах, даже просто рассказывают истории о себе… И на этом зарабатывают ежемесячно несколько тысяч долларов. Мечта, а не работа! На практике, одна лишь реклама на Ютуб и Twich или продвижение партнерок подобного дохода не приносят, если аудитория исчисляется десятками тысяч, как у большинства стримеров. Как удается получать высокий доход? Или все рассказы — красивые истории, мотивационные сказки от авторов, которым нужно чем-то заполнить свой блог? Ответ кроется в слове “donate”. banner banner

Что такое донаты и как они работают

Главная страница ДонатАлертс на английском языке

Думаю, все сталкивались со сбором пожертвований на различные цели. Это и есть donate — пожертвование с английского. В интернете они набирают тренд, и многие подписчики готовы жертвовать создателям канала на то, чтобы они продолжали создавать контент. Хотя размер донатов непредсказуем и точно спланировать бюджет не получается, для многих популярных стримеров они стали основным источником заработка. Даже небольшой канал с постоянной аудиторией в 1000 подписчиков или даже меньше может приносить порядка 300-400$ ежемесячно. Заработок крупных создателей контента исчисляется тысячами долларов. Впрочем, все зависит от аудитории. Иногда большую часть суммы составляет несколько крупных жертвователей. ��Популярная статья: ТОП 5+ способов �� заработать деньги на своем сайте с нуля. Схема донатов простая. Для сбора пожертвований существуют специальные сервисы. Вы регистрируетесь, получаете ссылку на личную страницу, которую нужно оставить под видео или в блоге. На многих платформах, например Twich, гиперссылки можно привязать к баннеру. Когда пользователи переходят по линку, открывается страница оплаты и, если предусмотрено, дополнительные опции, например возможность отправить сообщение, которое появится в стриме. Расплатиться можно картой или электронными деньгами, как при покупке в интернете или оплате онлайн-сервисов. Деньги будут зачислены через несколько секунд и появятся на счете в личном кабинете. Популярный среди стримеров и блогеров СНГ сервис для сбора донатов — DonationAlerts. Славу он свою завоевал за простоту пожертвований, большой список платежных систем и низкие комиссии. Как собирать донаты на стриме? Как DonationAlerts настроить и интегрировать сервис в OBS? Как выводить деньги? Об этом сегодня и поговорим.

DonationAlerts — что это

Как указано в Википедии, DonationAlerts — это крупнейший сервис для монетизации блогов и стримов с помощью донатов. Вместе с дочерним продуктом Boosty, Донейшн Алертс используют все крупные создатели видеоконтента рунета. DonationAlerts создан в 2015 году Сергеем Трифоновым для сбора пожертвований и организации платных подписок на каналы в Twitch, YouTube и Hitbox. В то время зарубежные англоязычные и испаноязычные блогеры начали активно использовать пожертвования от аудитории и платные подписки для развития своих проектов. В русскоязычном сегменте этот вид монетизации блогов и каналов на YouTube, Twich почти не использовался. Проблема была, в первую очередь, в отсутствии удобного инструмента, с помощью которого можно было бы быстро и безопасно пожертвовать небольшую сумму: без бюрократии, сложного оформления и с доступными комиссиями. Проект DonationAlerts начал быстро развиваться, в 2017 году его выкупила компания Mail.ru Group (сейчас принадлежит холдингу VK). С этого момента сервис для сбора донатов начал активнее продвигаться для использования в российских соцсетях ВКонтакте и Одноклассники. Постепенно начали добавляться новые способы оплаты, сервис вышел на международный рынок и стал доступным для блогеров из других регионов, прежде всего Европы. Интерфейс DonationAlerts доступен на восьми языках. Помимо русского, может быть переведен на английский, французский, португальский, шведский, польский, испанский, итальянский и немецкий. Хотя основная аудитория остается русскоязычной, удобно, если ваш блог смотрят фолловеры из других стран — страница оплаты будет для многих на родном языке. В Донат Алертс ссылку на донат можно разместить в принципе на любом ресурсе — от блога до социальных сетей. Но наиболее глубокая интеграция с модерацией часа и другими дополнительными опциями доступна для Twich, YouTube, VK, Facebook*, Одноклассники, Trovo. ❗❗❗Интересно знать — Как заработать на Trovo 100к+. Список поддерживаемых платформ в DonationAlertsСистема работает с популярными платежными системами. Отправить платное сообщение или купить подписку зрители могут через WebMoney, ЮMoney, PayPal, Qiwi, GPay, VK pay, картой Visa, Mastercard или перечислить деньги с мобильного счета. Также донатить можно с помощью криптовалют Ethereum и Bitcoin. �� Читайте также — Переход Эфира на POS в 2022 году: прогноз развития событий от экспертов. С момента создания расширился функционал. Система не просто принимает пожертвования, но предлагает покупать плюшки, например можно оставить платное сообщение, что стимулирует пользователей оставлять больше донатов. Через систему можно настроить платные подписки, устроить голосование или сбор средств. Также доступен прием от зрителей видео и картинок, которые можно сразу же запустить через стрим в небольшом окошке. Поддерживаемые платежные системы в DonationAlertsОсобенность — для всех виджетов, например, всплывающих оповещений, рулетки, индикатора сбора средств, можно получить ссылку для встраивания. Это позволяет интегрировать сбор доната с приложениями для организации и управления прямыми трансляциями, например, OBS Studio. Или сторонними стриминговыми сервисами, даже если платформа для видео трансляций не указана в списке. Обратите внимание! Платформа предлагает нативное приложение для стриминга с уже встроенными возможностями для пожертвований без дополнительной настройки — DonationAlerts Studio. Удобный функционал, возможности для прямых трансляций с камеры или захвата экрана. И все это бесплатно. Основные функции мобильной версии Донейшн Алертс Студио

Как пользоваться DonationAlerts

Начать собирать донаты со стримов не так сложно, как кажется. Зарегистрировать и настроить DonationAlerts можно буквально за 15 минут, и половина времени уйдет на выбор подходящего стиля оповещений, прослушивание понравившихся звуков, сообщающих о новых донатах. На практике все просто, но при первом запуске интерфейс может показаться непривычным и немного запутанным. Чтобы вы долго не изучали личный кабинет и смогли установить нужные настройки для сбора пожертвований с первой попытки, мы подготовили короткую инструкцию. Мы покажем только самые важные опции, которые нужно установить для сбора донатов. Дополнительные функции понадобятся продвинутым пользователям, и с ними разобраться вы сможете по мере развития канала.

Регистрация

Переходим на сайт DonationAlerts.com . Система автоматически выберет язык в соответствии с настройками браузера. Если нет — его можно поменять, выбрав из выпадающего списка. Выбор языка на сайте DonationAlerts.comПосле выбора языка регистрируемся на сайте. Для этого нажимаем на кнопку “Начать использовать”. Нажатие кнопки «Начать использовать» в DonationAlerts для регистрации В системе отсутствует стандартная регистрация через привязку к электронной почте. Зато удобная авторизация через один из сервисов: Twich, YouTube, VK, Facebook, Одноклассники, Dailymotion, Discord, TikTok, Trovo, Telegram, GoodGame, Apple ID. Вводить вручную информацию не придется. Выбор платформы в DonationAlerts при регистрации При регистрации DonationAlerts попросит доступ к вашей учетной записи. Включая просмотр списка подписчиков, адреса электронной почты, сообщений и личной информации. Не переживаем, это стандартный запрос, сервис хранит полную конфиденциальность. Открываем доступ, нажимая кнопку “Разрешить”. Нажатие кнопки «Разрешить» в DonationAlerts при регистрации Осталось немного. Вводим имя пользователя, соглашаемся с Условиями и Политикой конфиденциальности (желательно их прочитать), поставив напротив этого пункта “галочку”. На рассылку новостей по E-mail подписываемся или не подписываемся — по желанию. Жмем кнопку “Зарегистрироваться”. Ввод имени пользователя в DonationAlerts при регистрацииГотово. Попадаем в личный кабинет. Открывается “Панель управления”, где можно посмотреть статистику и динамику пожертвований, открыть сообщения, добавить виджеты и настроить их стиль, задать основные настройки. ❗❗❗Интересно знать: Как заработать на Яндекс Дзен статьями с нуля — гайд 2022. Панель управления в личном кабинете DonationAlerts

Базовые настройки

Чтобы начать пользоваться сервисом, нужно задать базовые настройки аккаунта. Для этого кликаем по кнопке основного меню в виде “сэндвича”, выбираем раздел “Настройки” и переходим во вкладку “Основные настройки”. Вкладка “Основные настройки” в личном кабинете DonationAlertsЗдесь можно подключить СМС подтверждение, задать секретный токен, привязать аккаунты желаемых сервисов. Обратите внимание! Привязать к аккаунту в DA для взаимодействия с данными можно даже сервисы, которые не указаны в списке. Для этого воспользуйтесь функцией OAuth. Найти ее можно в основных настройках.Авторизация сторонних приложений в личном кабинете DonationAlertsНа первом этапе важно задать “Региональные настройки”:

  • выбрать валюту. На выбор евро, белорусский и российский рубль, тенге, гривна, доллар США, бразильский реал, лира, злотый;
  • задать часовой пояс — это не главный по важности пункт. Но в зависимости от установленного времени отображается статистика. И время нужно учитывать при планировании будущих стримов и составлении расписания для трансляций;
  • язык — по умолчанию будет выбран тот, который вы задали при регистрации. Его можно поменять в любой момент.

Региональные настройки в личном кабинете DonationAlerts

Также в настройках аккаунта можно настроить спам-фильтр: задать нежелательные ссылки и список нежелательных слов.

Страница отправки сообщений

Новичку этот раздел может показаться маловажным. Это не так. От вида страницы, на которую перейдет пользователь при отправке денег, и опций зависит реакция аудитории. Прежде всего, желание жертвовать.

Для начала переходим в раздел “Настройки”, выбираем вкладку “Страница отправки сообщений”.

Вкладка «Страница отправки сообщений» в личном кабинете DonationAlerts

Здесь можно скопировать ссылку или сгенерировать QR-код с линком на страницу пожертвований. Вставляем ссылку под стримом и подписываем или привязываем к банеру. После перехода зрители попадут на страницу оплаты, где смогут отправить вам платное сообщение или оставить пожертвование.

Копирование ссылки на страницу пожертвований в личном кабинете DonationAlerts

Нас интересует настройка дизайна. Быть крутым дизайнером необязательно, здесь не получится внести глобальных изменений. Но шаблон можно подстроить под себя: задать фон, выбрать цвет шрифта и кнопок, добавить приветствие.

Настройка дизайна в личном кабинете DonationAlerts

Уделите внимание размеру минимальной суммы для отправки сообщения. Много донатов — это хорошо. Но если вам ежесекундно будут пересылать по 5 центов, чат окажется заспамленным оповещениями, и это оттолкнет более крупных спонсоров, зрителей в принципе. Важно найти золотую середину, учитывая размер и аудиторию канала. Если вам донатят небольшими суммами, пока не стоит повышать лимит, вместо этого работаем над улучшением качества контента, реализуем новые интересные идеи.

В целом, для небольшого канала рекомендуем стандартный размер минимальной суммы увеличить в два раза: 20 рублей, 0,3 usd и евро, 0,6 белорусских рублей и т. д.

Меню настройки минимальной суммы отправки сообщений в личном кабинете DonationAlerts

После внесения настроек не забываем нажать кнопку “Сохранить”.

Чтобы посмотреть изменения, скопируйте и вставьте ссылку в адресную строку в новой вкладке. После сохранения новых изменений, достаточно обновить страницу, чтобы увидеть их.

Страница для оплаты сообщений в DonationAlerts

Настройка виджета оповещений для Донатион Алертс

В DonationAlerts можно настроить стиль отображения всплывающих оповещений о донатах или новых подписчиках, которые будут появляться на экране во время стрима. Дизайн оповещений может быть всегда одинаковым или каждый раз меняться, если настроить несколько вариаций.

Сервис для приема донатов предлагает готовые стили оповещений по умолчанию для каждой подключенной платформы. Но их можно поменять, подготовить несколько вариантов для разных действий. Например, для обычных и крупных донатов будут использоваться разные анимированные картинки и звуковые сигналы.

Чтобы настроить стиль и условие появления оповещений, перейдите в меню “Виджеты” — “Оповещения”. Выберите необходимую группу и конкретную вариацию или добавьте новую, кликнув по соответствующей кнопке. Ненужные вариации можно отключить (с помощью переключателя) или удалить.

Нажмите на шестеренку и выберите команду “Настроить”. Внизу появится меню на пять вкладок: Основные настройки, Вид, Изображение, Звук, Текст, Дополнительно.

Настройка оповещений в DonationAlerts

В “Основных настройках” можно указать название и присвоить группу вариации, выбрать, для какого действия будет запускаться это оповещение (тип), задать условие появления и установить продолжительность активности оповещения, задержку появления текста.

Вкладка «Основные настройки» в DonationAlerts

В меню «Вид» выбираем формат оповещения, расположение текста по отношению к картинке или анимации: снизу, сбоку слева или справа, вверху или картинка на заднем фоне.

Вкладка «Вид» в DonationAlerts

В меню изображение можно выбрать одну из доступных гифок или загрузить свою. Чтобы изменить картинку, кликаем на название элемента.

Вкладка «Изображение» в DonationAlerts

Откроется окно. Выбираем анимацию из доступных. Если хочется что-то оригинальное — добавляем новую через кнопку “Загрузить”. “Применяем” изменения. Если нужно закрыть окно без сохранения — используем кнопку “Отмена”.

Кнопка загрузки анимации в DonationAlerts

Аналогично настраиваем Звук оповещения.

Вкладка «Звук» в DonationAlerts

Настраиваем “Шрифт”. Можно задать стиль для заголовка и сообщения, настроить цвет текста, анимацию, расстояние между словами и буквами, добавить тени, свечение, фон.

Настройка текста в DonationAlerts

В последней вкладке “Дополнительно” можно выбрать цвет фона для сообщения.

После настройки дизайна, можно посмотреть, как будет выглядеть оповещение. Нажмите кнопку “Запустить” в выбранной группе оповещений.

Проверка настройки оповещения в DonationAlerts

В браузере откроется отдельное окно предварительного просмотра. На странице настроек возле нужной вариации кликаем по шестеренке и выбираем опцию “Сделать тестовое оповещение”.

Выбор опции «Сделать тестовое оповещение» в DonationAlerts

В окне предпросмотра появится тестовое оповещение.

Тестовое оповещение в окне предпросмотра

Как сделать оповещение о донате в OBS

Теперь о том, как все это объединить и показывать оповещения о донатах на стриме. Для этого переходим на страницу “Виджеты”, открываем вкладку “Оповещения”. Выбираем группу вариаций, кликаем по опции “Показать ссылку для встраивания”.

- Опция “Показать ссылку для встраивания” в DonationAlerts

Копируем ссылку. Будьте внимательны, не показывайте и не передавайте ее сторонним лицам.

- Копирование ссылки для встраивания в виджете оповещений в DonationAlerts

Скопированную ссылку добавляем в приложение для трансляций. Для примера мы использовали OBS Studio как популярное и бесплатное приложение для стримов.

Чтобы добавить виджет “Оповещений”, откройте OBS Studio (или другое приложение, которым пользуетесь для трансляций). Найдите на панели инструментов раздел “Источники” (если он закрыт, можно найти в строке меню во вкладке “Док-панели”), кликните по кнопке “Добавить” (значок “+”). Чтобы вставить ссылку, нам нужно выбрать пункт “Браузер”.

Опции для добавления виджета «Оповещений» в OBS Studio

Перед нами откроется окно “Свойства браузер”. Сначала даем название источнику, применяем изменения. В новом окне вводим настройки виджета. В строку “URL-адрес” вставляем скопированную ссылку из раздела “Виджеты” — “Оповещения”. Задаем размеры (высоту и ширину), применяем изменения.

Ввод информации в окно «Свойства браузера» в OBS Studio

Обратите внимание! Если всплывающие оповещения слишком большие, их можно уменьшить уже после сохранения настроек простым перетаскиванием мышкой, потянув за одну из контрольных точек.

Изменение размера всплывающего оповещения в OBS Studio

Готово. Остается запустить текстовую трансляцию и проверить, правильно ли все работает.

Как добавить ссылку на донат в Твич

Логика говорит просто оставить ссылку в описании под стримом — ее разместить можно в два клика практически на любой платформе, включая TikTok, Instagram*, Facebook, Twich, YouTube. Но намного удобнее для зрителей, красивее и заметнее будет небольшой баннер в виде кнопки под видео.

Разберем, как реализовать такую опцию на Twich, времени много не займет.

Входим в аккаунт Twich, переходим на свой канал. Выбираем вкладку “Чат” или меню “Описание”.

Вкладка «Чат» в аккаунте Twich

Немного прокручиваем основную часть экрана вниз, пока не увидим переключатель “Редактировать панели”. Активируем опцию.

Активирование переключателя «Редактирование панели» в аккаунте Twich

Добавляем новую панель, кликнув по пустой плитке с “+”. Подобным образом можно добавлять любые кнопки и ссылки на другие сервисы под трансляцией в Twich.

Добавление новой панели в аккаунте Twich

В появившемся меню кликаем “Добавить текст или панель с изображением”. Потом нажимаем кнопку “Добавить изображение” и загружаем сделанный самостоятельно или скаченный с интернета баннер с надписью “Donate” (надпись может быть любой, главное, чтобы вашим зрителям было понятно). Учтите, ширина картинки не может быть больше 320 пикселей.

Добавление изображения с надписью «Донат» в аккаунте Twich

В строке “ссылка изображения” в этом же инструменте вставляем ссылку из личного кабинета DonationAlerts из раздела “Настройки” — “Страница отправки сообщений”.

Вставка ссылки из личного кабинета DonationAlerts в аккаунт Twich

После добавления не забываем “Применить” изменения. Готово. Теперь в описании появится кликабельная кнопка.

Пример кнопки доната в аккаунте Твич

Сбор средств

На практике, в обычных стримах пользователи неактивно жертвуют. Их можно подстегнуть, если запустить сбор средств. И да, это не обязательно должна быть важная цель. Например, можно собирать деньги на новый компьютер, видеокамеру — многие зрители с радостью помогут вам сделать контент еще лучше.

Цели могут быть и нетривиальными. Например, сбор на то, что вы сделаете какую-то глупость (выпьете стакан странной жидкости или разыграете соседа) или в формате челленджа. И целей сбора может быть несколько — зрители самостоятельно выберут, на какую донатить.

Настроить цели сбора можно в меню “Виджеты”.

Настройка цели сбора в меню “Виджеты” в DonationAlerts

Чтобы задать цель, нажимаем кнопку “Добавить цель сбора”. В появившемся окне задаем дату окончания кампании, целевую сумму и название. Одновременно может быть запущено несколько целей сбора.

Заполнение параметров цели сбора в DonationAlerts

После создания цели можно настроить дизайн виджета “Индикатора”, который будут видеть зрители. Доступно несколько готовых пресетов.

Настройка дизайн виджета “Индикатор” в DonationAlerts

Все шаблоны редактируемые. Вручную можно поменять шрифт, размер и цвет индикатора, расположение элементов.

Редактирование шаблона “Индикатор” в DonationAlerts

Внутристримовая статистика

Это необязательно меню. С помощью него можно выводить различные данные на экран для зрителей. Например, закрепить на некоторое время сообщение от последнего пользователя. Или зрителя, который пожертвовал самую большую сумму на данный момент. Также доступны для вывода такие данные: количество подписчиков, сколько собрано на данный момент, последний подписчик и др.

Настроить можно в разделе “Виджеты” — “Внутристримовая статистика”.

Настройка внутристримовой статистики в DonationAlerts

После внесения настроек не забываем сохранить изменения. Во вкладке “Внутристримовая статистика” появится новый виджет. Копируем ссылку и вставляем ее в OBS через добавление нового источника (выбираем пункт Browser). По тому же принципу, как и с оповещениями.

Копирование ссылки внутристримовой статистики в DonationAlerts

Как снять деньги с DonationAlerts

Теперь к главному — как вывести деньги на Донейшн Алертс? Сделать это несложно. Переходим в меню “Мои выплаты” и нажимаем кнопку “Добавить новый способ вывода”. Всего можно задать до 5 разных методов.

Выбор кнопки «Добавить новый способ вывода» в DonationAlerts

В настройках выбираем платежную систему, валюту и вводим реквизиты банковской карты или электронного кошелька. После выбора метода выплаты можно посмотреть комиссию на вывод для конкретного сервиса.

Настройка выплат в DonationAlerts

Внимательно просматриваем введенные данные и сохраняем.

Доступно шесть способов вывода: на банковскую карту, счет ЮMoney, Qiwi, PayPal, VK Pay, мобильный счет (только номера российских операторов).

Обратите внимание! Получать выплаты можно только после привязки номера мобильного. Для привязки карты нужно ввести код безопасности из SMS.

На сервисе DonationAlerts выплаты происходят автоматически раз в день. Запрашивать вывод не нужно. Деньги выводятся на приоритетный кошелек. Если он оказался недоступным — на следующий в очереди. Приоритет можно поменять.

Обратите внимание! DonationAlerts не берет дополнительных платежей за вывод. Комиссия за зачисление зависит от валюты, размера пожертвования и платежной системы. Для донатов в рублях — 7% от суммы при обороте до 50 000 руб. в месяц. Посмотреть все комиссии можно здесь.

Как удалить аккаунт в DonationAlerts

Чтобы удалить ставший ненужным аккаунт или случайно созданный дубликат учетной записи, обратитесь к службе поддержки. Для этого перейдите в меню “Помощь”.

Меню «Помощь» в DonationAlerts

Выберите вкладку “Общие вопросы” и пункт “Я не нашел ответ на свой вопрос”.

Вкладка “Общие вопросы” в DonationAlerts

Воспользуйтесь опцией “создать запрос”.

- Опция “создать запрос” в DonationAlerts

Создайте запрос на странице “центра поддержки”.

- Создание запроса в центре поддержки DonationAlerts

Заполните поля, укажите в описании свое пожелание удалить учетную запись.

Заполнение полей запроса в центре поддержки DonationAlerts

Подведем итоги…

DonationAlerts — удобный инструмент для стримеров и блогеров, которые планируют не просто увеличить доходы со своего канала, но сделать его основным заработком. Низкие среди аналогов комиссии, большой выбор платежных систем, простой вывод заработанных денег без неподъемных новичку минимальных порогов. Платформа предлагает дополнительные инструменты, например, платные сообщения, которые помогают мотивировать пользователей жертвовать больше. И собственную студию для стримов с интегрированными функциями по сбору донатов.

FAQ

Где взять ссылку на DonationAlerts?

В DonationAlerts ссылка на донат, по которой фолловеры смогут присылать вам пожертвования, доступна после регистрации в личном кабинете во вкладке “Настройки” — “Страница отправки сообщений”.

Тестовый донат donationalerts: как сделать?

Тестовый донат поможет увидеть, правильно ли вы все настроили. Запустите стрим и перейдите по ссылке баннера, который добавили под видео. В открывшемся окне сделайте оплату с карты или кошелька — он не должен быть привязанным во вкладке “Выплаты”. Сделать тестовый донат можно и на этапе настройки — скопируйте ссылку во вкладке “Страница отправки сообщений”, вставьте в адресную строку, сделайте оплату.

Как настроить donationalerts на Ютубе?

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

Как включить фильтр слов из черного списка?

Для этого перейдите во вкладку “Чат бот”, выберите пункт “Модерация”. Включите опцию “Черный список” и кликните по значку “шестеренки”. В появившемся меню выберите опцию “Настроить список”, нажмите кнопку “Добавить слова”. Добавьте таким образом нежелательные слова, установите наказание для протвинившихся зрителей.

Как настроить рулетку?

Чтобы настроить рулетку, перейдите в меню “Виджеты”, выберите вкладку “Рулетка”. Здесь можно добавить новые категории, настроить существующие, задать частоту выпадания карточки. После настройки добавьте ссылку в OBS.

Чат бот donationalerts — как установить?

Перейдите в раздел “Чатбот”, откройте вкладку “Аккаунты”. Привяжите платформы через кнопку “Подключить”, подтвердите доступ.

Какой минимальный донат DonationAlerts?

Минимальный размер доната зависит от валюты и платежной системы. Посмотреть можно в разделе с описанием комиссий.

Вам была полезна эта статья?

Introduction

The DonationAlerts public API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

HTTP API Requests

Requests and Responses

DonationAlerts public API endpoint for all HTTP methods is https://www.donationalerts.com/api/v1 , unless specified otherwise.

All responses from our API are provided in JSON format, and in some cases, a 204 No Content response code with an empty response body may be returned.

curl \ -X GET https://www.donationalerts.com/api/v1/alerts/donations \ -H "Authorization: Bearer "
HTTP/1.1 200 OK Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Date: Sat, 1 Sep 2019 18:42:33 GMT Content-Language: en_US
 < "data": [ < "id": 30530030, "name": "donation", "username": "Ivan", "message": "Hello!", "amount": 500, "currency": "RUB", "is_shown": 1, "created_at": "2019-09-29 09:00:00", "shown_at": null >], "links": < "first": "https://www.donationalerts.com/api/v1/alerts/donations?page=1", "last": "https://www.donationalerts.com/api/v1/alerts/donations?page=1", "prev": null, "next": null >, "meta": < "current_page": 1, "from": 1, "last_page": 1, "path": "https://www.donationalerts.com/api/v1/alerts/donations", "per_page": 30, "to": 1, "total": 1 >>

Pagination

For the performance reasons DonationAlerts public API paginates the response output. This is because returning the entire data set might be feasible for some queries but prohibitive for others that return a very large amount of data.

API methods that support pagination will return meta and links parts in their response body.

Description
current_page
Current page index
First element index
Total number of pages
The current path
Number of items per page
Last element index
Total number of items
Description
Link to the first page
Link to the last page
string, null
Link to the previous page. Or null if there no previous page
string, null
Link to the next page. Or null if there no next page

To specify a page, add the page parameter to the query.

The following example requests page 2:

curl \ -X GET https://www.donationalerts.com/api/v1/alerts/donations?page=2 \ -H "Authorization: Bearer "

Errors and Statuses

DonationAlerts uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with DonationAlerts’ servers.

HTTP Statuses
Description
Standard response for successful HTTP requests
201 Created
The request has been fulfilled, resulting in the creation of a new resource
202 Accepted

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs

204 No Content
The server successfully processed the request and is not returning any content
400 Bad Request
The server cannot or will not process the request due to an apparent client error
401 Unauthorized
Authentication is required and has failed or has not yet been provided
404 Not Found
The requested resource could not be found but may be available in the future
500 Internal Server Error

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable

HTTP/1.1 401 Unauthorized Server: nginx/1.13.5 Content-Type: application/json

Limitations

All API requests are subject to rate limits. We limit requests to our HTTP API methods for each application by 60 requests per minute, making it 1 request per second.

Locales

Some of the APIs may support internationalization requiring the developer to specify the locale. All the supported locales are listed below:

  • be_BY — Belarusian;
  • de_DE — German;
  • en_US — English (USA);
  • es_ES — Spanish;
  • es_US — Spanish (USA);
  • et_EE — Estonian;
  • fr_FR — French;
  • he_HE — Hebrew;
  • it_IT — Italian;
  • ka_GE — Georgian;
  • kk_KZ — Kazakh;
  • ko_KR — Korean;
  • lv_LV — Latvian;
  • pl_PL — Polish;
  • pt_BR — Portuguese (Brazil);
  • ru_RU — Russian;
  • sv_SE — Swedish;
  • tr_TR — Turkish;
  • uk_UA — Ukrainian;
  • zh_CN — Chinese.

Currencies

Some of the APIs require currency input or provide currency output in response body.

The list of supported input currencies:

  • EUR — Euro;
  • USD — US Dollar;
  • RUB — Russian Ruble;
  • BRL — Brazilian Real;
  • TRY — Turkish Lira.

The list of supported output currencies:

  • EUR — Euro;
  • USD — US Dollar;
  • RUB — Russian Ruble;
  • BYN — Belarusian Ruble;
  • KZT — Tenge;
  • UAH — Hryvnia;
  • BRL — Brazilian Real;
  • TRY — Turkish Lira.

Request Signatures

Some of the APIs require request signature.

The request signature is a SHA256 hashed string formed from a alphabetically sorted values of request parameters (with every value interpreted as a string) and appended API client secret key to the end.

For example, if request parameters contain:

foo=xyz&bar=abc

Then the signature must be generated as following:

SHA256( abc + xyz + )

Centrifugo

We use Centrifugo to deliver real-time notifications when certain event occurs. It runs as standalone server and takes care of handling persistent connections from application users.

Centrifugo WebSocket connection endpoint:

wss://centrifugo.donationalerts.com/connection/websocket

Subscriptions to Centrifugo’s private channels must be properly signed by API application. For the detailed information please read special chapter of Centrifugo documentation about private channel subscriptions.

Steps to Connect to the Centrifugo’s WebSocket Server

  • Connecting to the Centrifugo WebSocket Server and obtaining Centrifugo’s UUIDv4 Client ID
  • Subscribing to the Private Channels and Obtaining Connection Tokens
  • Connecting to the Private Channels

1. Connecting to the Centrifugo WebSocket Server and obtaining Centrifugo’s UUIDv4 Client ID

In order to connect to the Centrifugo’s WebSocket Server, first of all, you need to open connection with the Centrifugo WebSocket connection endpoint. Once connection is opened we need to send the message to the WebSocket server. This message must contain message ID and user Centrifugo connection token obtained earlier with the /user/oauth request. Such message must be JSON encoded and should look like this:

  • Query String
    Description
  • channels
    string
    Array of private channel names to subscribe to

    required
  • client
    string
    Centrifugo UUIDv4 client ID obtained upon connection to the Centrifugo’s WebSocket server

    required

Query String
Description
Private channel name
Centrifugo connection token. This token can be used to connect to the private channel

HTTP/1.1 200 OK Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Sat, 28 Sep 2019 11:19:57 GMT
< "channels": [ < "channel": "$alerts:donation_", "token": "" > ] >

Response contains array of the subscribed channels and tokens that can be now used to connect to the corresponding private channels.

3. Connecting to the Private Channels

Finally, in order to connect to the subscribed channels, you need to send another message via previously opened WebSocket connection. Each message must contain channel name and connection token, and should look like this:

< "params": < "channel": "$alerts:donation_", "token": "" >, "method": 1, "id": 2 >

After that, you’ll receive confirmation message indicating successful channel connection:

Now you are ready to receive real-time event notifications.

Authorization

We use the OAuth 2.0 authorization protocol to issue access to user data. If you are not familiar with the concept of OAuth 2.0, please read RFC 6749 first. All methods of DonationAlerts public API require authorization.

Access Token

Access tokens are the thing that applications use to make API requests on behalf of a user. The access token represents the authorization of a specific application to access specific parts of a user’s data. Access tokens must be kept confidential in transit and in storage. The only parties that should ever see the access token are the application itself, the authorization server, and resource server. The application should ensure the storage of the access token is not accessible to other applications on the same device. The access token can only be used over an https connection, since passing it over a non-encrypted channel would make it trivial for third parties to intercept.

Scopes

Scope is a mechanism in OAuth 2.0 to limit an application’s access to a user’s account. An application can request one or more scopes, this information is then presented to the user in the consent screen, and the access token issued to the application will be limited to the scopes granted.

The OAuth spec allows the authorization server or user to modify the scopes granted to the application compared to what is requested, although there are not many examples of services doing this in practice. OAuth does not define any particular values for scopes, since it is highly dependent on the service’s internal architecture and needs.

DonationAlerts provides 3 scopes to third-party services:

DonationAlerts Scopes
Description
oauth-user-show
Obtain profile data
oauth-donation-subscribe
Subscribe to new donation alerts
oauth-donation-index
View donations
oauth-custom_alert-store
Create custom alerts
oauth-goal-subscribe
Subscribe to donation goals updates
oauth-poll-subscribe
Subscribe to polls updates

Grant Type: Authorization Code

The authorization code grant type used because it is optimized for server-side applications, where source code is not publicly exposed, and client secret confidentiality can be maintained. This is a redirection-based flow, which means that the application must be capable of interacting with the user-agent and receiving API authorization codes that are routed through the user-agent.

Authorization Steps

  • Application registration
  • Authorization request
  • Getting access token
  • Authorization code to access token exchange

1. Application Registration

The application developer must register the application here in order to get tokens. Once the application is registered, the authorization service will issue «client credentials» in the form of a client identifier and a client secret. The client_id is a publicly exposed string that is used by the service API to identify the application, and is also used to build authorization URLs that are presented to users. The client_secret is used to authenticate the identity of the application to the service API when the application requests to access a user’s account, and must be kept private between the application and the API.

2. Authorization Request

The user is given an authorization code link (or redirect) to the https://www.donationalerts.com/oauth/authorize with parameters client_id , redirect_uri , response_type and scope .

GET https://www.donationalerts.com/oauth/authorize
Request Parameters
Query String
Description
The client ID received from DonationAlerts
redirect_uri
The URL in your where users will be sent after authorization
response_type=code
Specifies that application is requesting an authorization code grant
A space-delimited list of scopes

When the user clicks the link, they must first log in to the service, to authenticate their identity (unless they are already logged in). Then they will be prompted by the service to authorize or deny the application access to their account. Here is an example authorize application prompt.

3. Getting Authorization Code

If the user allows access to personal data, the service redirects the user-agent to the application redirect URI, which was specified during the client registration, along with an authorization code. The authorization code will be available as the value of the code parameter.

4. Getting Access Token

The authorization code must be exchanged for an access token in https://www.donationalerts.com/oauth/token with grant_type , client_id , client_secret , redirect_uri and code parameters.

POST https://www.donationalerts.com/oauth/token
Request Parameters Request Example Response Parameters Response Example
Query String
Description
grant_type=authorization_code
The grant type
The application ID you received from DonationAlerts
client_secret
The application secret you received from DonationAlerts
redirect_uri
The URL where users will be sent after authorization
The authorization code

curl \ -X POST https://www.donationalerts.com/oauth/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=authorization_code&client_id= &client_secret=&redirect_uri=&code="

Query String
Description
token_type
Token type
expires_in
Token expiration timestamp
access_token
Access token
refresh_token
Refresh token

HTTP/1.1 200 OK Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Sat, 28 Sep 2019 11:19:57 GMT

Refreshing Access Tokens

The Refresh Token grant type is used by clients to exchange a refresh token for an access token when the access token has expired.

The service will generate and return a new access token if provided data is valid. The server may issue a new refresh token as well, but if the response does not contain a new refresh token the existing refresh token will still be valid.

POST https://www.donationalerts.com/oauth/token
Request Parameters Request Example Response Parameters Response Example
Query String
Description
grant_type=refresh_token
The grant type
refresh_token
The refresh_token you received from DonationAlerts
The application ID you received from DonationAlerts
client_secret
The application secret you received from DonationAlerts
A space-delimited list of scopes

curl \ -X POST https://www.donationalerts.com/oauth/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=refresh_token&refresh_token=&client_id= &client_secret=&scope="

Query String
Description
token_type
Token type
expires_in
Token expiration timestamp
access_token
Access token
refresh_token
Refresh token

HTTP/1.1 200 OK Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Sat, 28 Sep 2019 11:19:57 GMT

Grant Type: Implicit

The implicit grant is similar to the authorization code grant. The token is returned to the client without exchanging an authorization code. This grant is most commonly used for JavaScript or mobile applications where the client credentials can't be securely stored.

Authorization Steps

  • Application registration
  • Authorization request
  • Getting access token

1. Application Registration

The application developer must register the application here in order to get tokens. Once the application is registered, the authorization service will issue "client credentials" in the form of a client identifier and a client secret. The client_id is a publicly exposed string that is used by the service API to identify the application, and is also used to build authorization URLs that are presented to users. The client_secret is used to authenticate the identity of the application to the service API when the application requests to access a user’s account, and must be kept private between the application and the API.

2. Authorization Request

The user is given an authorization request (or redirect) to the https://www.donationalerts.com/oauth/authorize with parameters client_id , redirect_uri , response_type and scope .

GET https://www.donationalerts.com/oauth/authorize
Request Parameters
Query String
Description
The client ID received from DonationAlerts
redirect_uri
The URL in your where users will be sent after authorization
response_type=token
Specifies that application is requesting an access token
A space-delimited list of scopes

When the user clicks the link, they must first log in to the service, to authenticate their identity (unless they are already logged in). Then they will be prompted by the service to authorize or deny the application access to their account. Here is an example authorize application prompt.

3. Getting Access Token

If the user allows access to personal data, the service redirects the user-agent to the application redirect URI, which was specified during the client registration, along with an access token. The access token will be available as the value of the access_token parameter in the hash part of the URL.

API v1

Users

User Profile Information

Obtains user profile information. Requires user authorization with the oauth-user-show scope.

GET https://www.donationalerts.com/api/v1/user/oauth
Request Example Response Parameters Response Example

curl \ -X GET https://www.donationalerts.com/api/v1/user/oauth \ -H "Authorization: Bearer "

Query String
Description
The unique and unchangeable user identifier
The unique user name
The unique displayed user name
The URL to the personalized graphical illustration
The email address
socket_connection_token
Centrifugo connection token
Please note that code and name may change at any time upon user rename

HTTP/1.1 200 OK Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Sat, 28 Sep 2019 11:19:57 GMT

Donations

Donation Alerts List

Obtains array of objects of user donation alerts list. Requires user authorization with the oauth-donation-index scope.

GET https://www.donationalerts.com/api/v1/alerts/donations
Request Example Response Parameters Response Example

curl \ -X GET https://www.donationalerts.com/api/v1/alerts/donations \ -H "Authorization: Bearer "

Query String
Description
The unique donation alert identifier
Type of the alert. Always donation in this case
The name of the user who sent the donation and the alert
message_type
The message type. The possible values are text for a text messages and audio for an audio messages
The message sent along with the donation and the alert
The donation amount
The currency code (ISO 4217 formatted)
A flag indicating whether the alert was shown in the streamer's widget
created_at
The donation date and time (YYYY-MM-DD HH.MM.SS formatted)
string, null

Date and time indicating when the alert was shown (YYYY-MM-DD HH.MM.SS formatted). Or null if the alert is not shown yet

HTTP/1.1 200 OK Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Sat, 28 Sep 2019 11:19:57 GMT
 < "data": [ < "id": 30530030, "name": "donation", "username": "Ivan", "message_type": "text", "message": "Hello!", "amount": 500, "currency": "RUB", "is_shown": 1, "created_at": "2019-09-29 09:00:00", "shown_at": null >], "links": < "first": "https://www.donationalerts.com/api/v1/alerts/donations?page=1", "last": "https://www.donationalerts.com/api/v1/alerts/donations?page=1", "prev": null, "next": null >, "meta": < "current_page": 1, "from": 1, "last_page": 1, "path": "https://www.donationalerts.com/api/v1/alerts/donations", "per_page": 30, "to": 1, "total": 1 >>

Custom Alerts

Custom alerts are the fully content-customizable alerts that allow the developer to create uniquely designed alerts and send it to the streamer's broadcast.

It is required for the streamer to have a variation for the Alerts widget with "Custom alerts" type for custom alerts to display.

Send Custom Alerts

Sends custom alert to the authorized user. Requires user authorization with the oauth-custom_alert-store scope.

POST https://www.donationalerts.com/api/v1/custom_alert
Request Parameters Request Example Response Parameters Response Example
Query String
Description
external_id
Up to 32 characters long unique alert ID generated by the application developer
Up to 255 characters long string that will be displayed as a header
Up to 300 characters long string that will be displayed inside the message box
A value containing 0 or 1. Determines whether the alert should be displayed or not. Default value: 0
Up to 255 characters long URL to the image file that will displayed along with the custom alert
Up to 255 characters long URL to the sound file that will played when displaying the custom alert

curl \ -X POST https://www.donationalerts.com/api/v1/custom_alert \ -H "Authorization: Bearer " \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "external_id=12&header=Custom%20header&message=Custom%20message&image_url=https%3A%2F%2Fcdn.frankerfacez.com%2Femoticon%2F408827%2F4"

Query String
Description
The unique custom alert identifier
external_id
string, null
Unique alert ID generated by the application developer. Or null if ID was not provided
string, null
Text that will be displayed as a header. Or null if text was not provided
string, null
Text that will be displayed inside the message box. Or null if text was not provided
string, null

URL to the image file that will displayed along with the custom alert. Or null if URL was not provided

string, null

URL to the sound file that will played when displaying the custom alert. Or null if URL was not provided

A flag indicating whether the alert was shown in the streamer's widget
created_at
The date and time (YYYY-MM-DD HH.MM.SS formatted) when custom alert was created
string, null

Date and time indicating when the alert was shown (YYYY-MM-DD HH.MM.SS formatted). Or null if the alert is not shown yet

HTTP/1.1 201 Created Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Thu, 24 Sep 2020 12:04:23 GMT

Merchandises

Custom alerts are the fully content-customizable alerts that allow the developer to create uniquely designed alerts and send it to the streamer's broadcast.

It is required for the streamer to have a variation for the Alerts widget with "Custom alerts" type for custom alerts to display.

Create Merchandise

Creates new merchandise. This API is a part of the Merchandise Advertisement API.

POST https://www.donationalerts.com/api/v1/merchandise
Request Parameters Request Example Response Parameters Response Example
Query String
Description
merchant_identifier
Merchant's ID on DonationAlerts
merchandise_identifier
Up to 16 characters long unique merchandise ID generated by the merchant

Array of up to 1024 characters long strings representing the name of the merchandise in different locales. At minimum, a title for the en_US locale is required

A value containing 0 or 1. Determines whether the merchandise is available for purchase or not. Default value: 0

is_percentage

A value containing 0 or 1. Determines whether the price_service and price_user parameters are recognized as amounts in a currency of the currency parameter or calculated as a percent of the sale's total. Default value: 0

One of the available currencies of merchandise. All revenue calculations will be performed according this value

price_user
Amount of revenue added to streamer for each sale of the merchandise
price_service
Amount of revenue added to DonationAlerts for each sale of the merchandise

Up to 128 characters long URL to the merchandise's web page. You may include the and patterns in the URL that will be replaced in a UI with the user's ID and user's merchandise promocode

Up to 128 characters long URL to the merchandise's image
Date and time when the merchandise becomes inactive represented as Unix timestamp

curl --location --request POST 'https://www.donationalerts.com/api/v1/merchandise' \ --header 'Authorization: Bearer ' \ --form 'merchant_identifier=MARKET_GAMES_MAIL_RU' \ --form 'merchandise_identifier=8082' \ --form 'title[en_US]=Credit case' \ --form 'title[ru_RU]=Кредитный кейс' \ --form 'is_active=1' \ --form 'is_percentage=1' \ --form 'currency=USD' \ --form 'price_user=30' \ --form 'price_service=15' \ --form 'url=https://market.games.mail.ru/game/1?product_id=8082&user_id=' \ --form 'img_url=https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png' \ --form 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'

Query String
Description
Unique merchandise ID on DonationAlerts
Object carrying identifier and name fields that contains information about the merchant
identifier
Unique merchandise ID on the merchant's online store
Object carrying merchandise's titles in different locales
A flag indicating whether the merchandise is available for purchase or not
is_percentage

A flag indicating whether the price_service and price_user parameters should be recognized as absolute values of the currency currency or as a percent of the sale's total

The currency code of the merchandise (ISO 4217 formatted)
price_user
Amount of revenue added to streamer for each sale of the merchandise
price_service
Amount of revenue added to DonationAlerts for each sale of the merchandise
string, null
URL to the merchandise's web page. Or null if URL is not set
string, null
URL to the merchandise's image. Or null if image is not set
string, null

Date and time indicating when the merchandise becomes inactive (YYYY-MM-DD HH.MM.SS formatted). Or null if end date is not set

HTTP/1.1 201 Created Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Thu, 15 Nov 2020 08:37:37 GMT
< "data": < "id": 3, "merchant": < "identifier": "MARKET_GAMES_MAIL_RU", "name": "Market games@mail.ru" >, "identifier": "8082", "title": < "en_US": "Credit case", "ru_RU": "Кредитный кейс" >, "is_active": 1, "is_percentage": 1, "currency": "USD", "price_user": 30, "price_service": 15, "url": "https://market.games.mail.ru/game/1?product_id=8082&user_id=", "img_url": "https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png", "end_at": null > >

Update Merchandise

Updates merchandise. This API is a part of the Merchandise Advertisement API.

PUT https://www.donationalerts.com/api/v1/merchandise/
Request Parameters Request Example Response Parameters Response Example
Query String
Description
merchant_identifier
Merchant's ID on DonationAlerts
merchandise_identifier
Up to 16 characters long unique merchandise ID generated by the merchant

Array of up to 1024 characters long strings representing the name of the merchandise in different locales. At minimum, a title for the en_US locale is required

A value containing 0 or 1. Determines whether the merchandise is available for purchase or not. Default value: 0

is_percentage

A value containing 0 or 1. Determines whether the price_service and price_user parameters are recognized as amounts in a currency of the currency parameter or calculated as a percent of the sale's total. Default value: 0

One of the available currencies of merchandise. All revenue calculations will be performed according this value

price_user
Amount of revenue added to streamer for each sale of the merchandise
price_service
Amount of revenue added to DonationAlerts for each sale of the merchandise

Up to 128 characters long URL to the merchandise's web page. You may include the and patterns that will be replaced in a UI with the user's ID and user's merchandise promocode

Up to 128 characters long URL to the merchandise's image
Date and time when the merchandise becomes inactive represented as Unix timestamp

curl --location --request PUT 'https://www.donationalerts.com/api/v1/merchandise/3' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'title[en_US]=Credit case' \ --data-urlencode 'title[ru_RU]=Кредитный кейс' \ --data-urlencode 'is_active=1' \ --data-urlencode 'is_percentage=1' \ --data-urlencode 'currency=USD' \ --data-urlencode 'price_user=30' \ --data-urlencode 'price_service=15' \ --data-urlencode 'url=https://market.games.mail.ru/game/1?product_id=8082' \ --data-urlencode 'img_url=https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png' \ --data-urlencode 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'

Query String
Description
Unique merchandise ID on DonationAlerts
Object carrying identifier and name fields that contains information about the merchant
identifier
Unique merchandise ID on the merchant's online store
Object carrying merchandise's titles in different locales
A flag indicating whether the merchandise is available for purchase or not
is_percentage

A flag indicating whether the price_service and price_user parameters should be recognized as absolute values of the currency currency or as a percent of the sale's total

The currency code of the merchandise (ISO 4217 formatted)
price_user
Amount of revenue added to streamer for each sale of the merchandise
price_service
Amount of revenue added to DonationAlerts for each sale of the merchandise
string, null
URL to the merchandise's web page. Or null if URL is not set
string, null
URL to the merchandise's image. Or null if image is not set
string, null

Date and time indicating when the merchandise becomes inactive (YYYY-MM-DD HH.MM.SS formatted). Or null if end date is not set

HTTP/1.1 200 OK Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Thu, 15 Nov 2020 08:37:37 GMT
< "data": < "id": 3, "merchant": < "identifier": "MARKET_GAMES_MAIL_RU", "name": "Market games@mail.ru" >, "identifier": "8082", "title": < "en_US": "Credit case", "ru_RU": "Кредитный кейс" >, "is_active": 1, "is_percentage": 1, "currency": "USD", "price_user": 30, "price_service": 15, "url": "https://market.games.mail.ru/game/1?product_id=8082&user_id=", "img_url": "https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png", "end_at": null > >

Update or Create Merchandise

A combined method which allows to update merchandise, or create if it doesn't exist yet. If preferred, it can be used insdead of separate create and update API methods as this method allows to update a merchandise without need store DonationAlerts merchandise ID. This API is a part of the Merchandise Advertisement API.

PUT https://www.donationalerts.com/api/v1/merchandise//
Request Parameters Request Example Response Parameters Response Example
Query String
Description

Array of up to 1024 characters long strings representing the name of the merchandise in different locales. At minimum, a title for the en_US locale is required

A value containing 0 or 1. Determines whether the merchandise is available for purchase or not. Default value: 0

is_percentage

A value containing 0 or 1. Determines whether the price_service and price_user parameters are recognized as amounts in a currency of the currency parameter or calculated as a percent of the sale's total. Default value: 0

One of the available currencies of merchandise. All revenue calculations will be performed according this value

price_user
Amount of revenue added to streamer for each sale of the merchandise
price_service
Amount of revenue added to DonationAlerts for each sale of the merchandise

Up to 128 characters long URL to the merchandise's web page. You may include the and patterns in the URL that will be replaced in a UI with the user's ID and user's merchandise promocode

Up to 128 characters long URL to the merchandise's image
Date and time when the merchandise becomes inactive represented as Unix timestamp

curl --location --request PUT 'https://www.donationalerts.com/api/v1/merchandise/MARKET_GAMES_MAIL_RU/8082' \ --header 'Authorization: Bearer ' \ --form 'title[en_US]=Credit case' \ --form 'title[ru_RU]=Кредитный кейс' \ --form 'is_active=1' \ --form 'is_percentage=1' \ --form 'currency=USD' \ --form 'price_user=30' \ --form 'price_service=15' \ --form 'url=https://market.games.mail.ru/game/1?product_id=8082&user_id=' \ --form 'img_url=https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png' \ --form 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'

Query String
Description
Unique merchandise ID on DonationAlerts
Object carrying identifier and name fields that contains information about the merchant
identifier
Unique merchandise ID on the merchant's online store
Object carrying merchandise's titles in different locales
A flag indicating whether the merchandise is available for purchase or not
is_percentage

A flag indicating whether the price_service and price_user parameters should be recognized as absolute values of the currency currency or as a percent of the sale's total

The currency code of the merchandise (ISO 4217 formatted)
price_user
Amount of revenue added to streamer for each sale of the merchandise
price_service
Amount of revenue added to DonationAlerts for each sale of the merchandise
string, null
URL to the merchandise's web page. Or null if URL is not set
string, null
URL to the merchandise's image. Or null if image is not set
string, null

Date and time indicating when the merchandise becomes inactive (YYYY-MM-DD HH.MM.SS formatted). Or null if end date is not set

HTTP/1.1 201 Created Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Thu, 15 Nov 2020 08:37:37 GMT
< "data": < "id": 3, "merchant": < "identifier": "MARKET_GAMES_MAIL_RU", "name": "Market games@mail.ru" >, "identifier": "8082", "title": < "en_US": "Credit case", "ru_RU": "Кредитный кейс" >, "is_active": 1, "is_percentage": 1, "currency": "USD", "price_user": 30, "price_service": 15, "url": "https://market.games.mail.ru/game/1?product_id=8082&user_id=", "img_url": "https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png", "end_at": null > >

Merchandise Sale Notifications

Send Sale Alerts

Creates new merchandise sale alert. This API is a part of the Merchandise Advertisement API.

POST https://www.donationalerts.com/api/v1/merchandise_sale
Request Parameters Request Example Response Parameters Response Example
Query String
Description
DonationAlerts' user ID to which this merchandise sale referenced
external_id
Up to 32 characters long unique sale ID generated by the developer
merchant_identifier
Merchant's ID on DonationAlerts
merchandise_identifier
Merchant's merchandise ID which was bought by the customer
Grand total of the sale
One of the available currencies of merchandise sale indicating the currency of amount
bought_amount
Total number of bought items. Default value: 1
The name of the customer
The message sent by the customer while purchasing the merchandise

curl --location --request POST 'https://www.donationalerts.com/api/v1/merchandise_sale' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'user_id=3' \ --data-urlencode 'amount=100' \ --data-urlencode 'currency=RUB' \ --data-urlencode 'merchant_identifier=MARKET_GAMES_MAIL_RU' \ --data-urlencode 'merchandise_identifier=3372' \ --data-urlencode 'external_id=1' \ --data-urlencode 'bought_amount=2' \ --data-urlencode 'username=John' \ --data-urlencode 'message=This is a test message' \ --data-urlencode 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'

Query String
Description
The unique merchandise sale alert identifier
Type of the generated alert
external_id
Unique sale ID generated by the developer
string, null
The name of the customer. Or null if customer is unknown
string, null
The message sent by the customer while purchasing the merchandise. Or null if text was not provided
Grand total amount of the sale
The currency code of the merchandise sale (ISO 4217 formatted)
bought_amount
Total number of bought items
A flag indicating whether the alert was shown in the streamer's widget
created_at
The date and time (YYYY-MM-DD HH.MM.SS formatted) when sale alert was created
string, null

Date and time indicating when the alert was shown (YYYY-MM-DD HH.MM.SS formatted). Or null if the alert is not shown yet

HTTP/1.1 201 Created Server: nginx/1.13.5 Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-cache, private Date: Thu, 24 Sep 2020 11:36:14 GMT

Centrifugo Channels

DonationAlerts API offers the variety of Centrifugo channels for receiving real-time event notifications.

You can read more about Centrifugo in the Centrifugo section of this documentation.

Each message sent to a channel carries the reason attribute in addition to the original resource. This attribute describes the event that occured upon message dispatch.

New Donation Alerts

Subscribing to this channel allows to receive new user donation alerts. Requires user authorization with the oauth-donation-subscribe scope.

Centrifugo channel name — $alerts:donation_

Messages sent to this channel contain the donation resource represented the same as described in Donations Alerts List.

Donation Goals Updates

Subscribing to this channel allows to receive updates regarding donation goals. Requires user authorization with the oauth-goal-subscribe scope.

Centrifugo channel name — $goals:goal_

Messages sent to this channel contain the donation goal resource represented as described below.

Donation Goal Resource
Description
The unique donation goal identifier
A flag indicating whether the donation goal is in progress or not
The donation goal title
The currency code of the donation goal (ISO 4217 formatted)
start_amount
Starting amount of the donation goal
raised_amount
Currently raised amount including the start_amount value
goal_amount
Goal amount of the donation goal
started_at
The date and time (YYYY-MM-DD HH.MM.SS formatted) when donation goal was started
expires_at
string, null

The date and time (YYYY-MM-DD HH.MM.SS formatted) when donation goal is scheduled to end. Or null if end date is not set

Polls Updates

Subscribing to this channel allows to receive updates regarding polls. Requires user authorization with the oauth-poll-subscribe scope.

Centrifugo channel name — $polls:poll_

Messages sent to this channel contain the poll resource represented as described below.

Poll Resource
Description
The unique poll identifier
A flag indicating whether the poll is in progress or not
The poll title
allow_user_options
A flag indicating whether the poll allows donors to add their own poll options or not

Type of the poll that defines how poll winner is calculated. count - finds winner by the most number of donations; sum - finds winner by the most sum of donations

Array of available poll options represented as Poll Option resource
Poll Option Resource
Description
The unique poll option identifier
The poll option title
amount_value

The absolute value of poll option. Depending on poll type the value may contain number or sum of donations

amount_percent
The percent value of poll option relative other poll options

A flag indicating whether the poll option is the poll winner or not. Please note that poll may have multiple winners if maximium amount_value value is shared by several poll options

Advertisement

Merchandises

Overview

The Merchandises API is a set of the API methods that allows the merchant to sell their merchandise via DonationAlerts' streamers using a revenue sharing model.
Using the provided API methods it's possible to create and update merchandises, and to notify DonationAlerts when new sale occurs.

Please note that the access to this API is given as per request. For more details about integration contact us via business@donationalerts.com.

  • Merchant - a service or online store integrated with the DonationAlerts' Merchandise API;
  • Merchandise - a product that is available for purchase on the Merchant's online store;
  • Broadcasting Platform - a service that allows its users to livestream media content (for example, Twitch or YouTube);
  • Streamer - a user that livestreams on the Broadcasting Platform and registered on DonationAlerts as a streamer;
  • Customer - a user that intends to purchase Merchant's Merchandise. Most often the Customer is a viewer of the Streamer's livestream.

Interaction Scheme

Merchandises API requires server to server interaction for data exchange between DonationAlerts and Merchant.

To get started with the merchandises sales, the Merchant must be integrated into DonationAlerts. The integration process may vary as it mostly depends on Merchant's possibilities and preferences. For example, it's possible to create, update, or update or create merchandises via API or we may handle it entirely on our side.
But in all occurrences, it is required to integrate with the Send Sale Alerts API as a part of the minimal integration with the Merchandises API, so DonationAlerts can be notified about new sales.

As soon as the merchandise is integrated, it's possible start with the merchandises sales. The image below illustrates the whole process from the start of the purchase procedure to display of new sale alert on the Streamer's livestream:

  1. Customer visits Streamer's livestream on Broadcasting Platform in their web browser or application.
  2. From there Customer transitions to the Merchandise's product webpage hosted on the Merchant's online store. This might be done directly from the Broadcasting Platform if the Streamer placed the Merchandise's URL there (2.a) or by going through the Streamer's donation page on DonationAlerts (2.b, 2.c) as all of the Streamer's merchandises are listed there. Optionally, Merchandise's URL may carry DonationAlerts' user ID or the Streamer's promocode in its query parameters, so Merchant may easily recognize which Streamer's referral link was used.
  3. On the Merchant's online store the Customer goes through the usual checkout process and being redirected to the Payment Processor to complete the purchase.
  4. After the purchase the Customer is redirected back to the Merchant's online store and Payment Processor notifies the Merchant about new purchase.
  5. Merchant notifies DonationAlerts about new purchase using Send Sale Alerts API.
  6. Upon new sale notification DonationAlerts adds revenue to the Streamer's balance on DonationAlerts and generates new merchandise sale alert that is being sent to the Streamer's alerts widget.
  7. The Streamer's alerts widget receives merchandise sale alert and displays it while Streamer's broadcasting software captures the content of the alerts widget and transmits it to the Broadcasting Platform along with other media content.

Plugins & Libraries

For your convenience we have created various plugins and libraries that will help you to quick start with various parts of DonationAlerts API in different development environments.

Unreal Engine 4 Plugin

Allows to easily authorize the player and send custom alerts. The plugin is available on its GitHub page: https://github.com/ufna/DonationAlerts.

Usage

How to authenicate user:

How to send custom alert:

How to react to donation events:

How to react to donation goal events:

How to react to poll events:

Секретный токен donation alerts для чего

DonationAlerts
5.19K subscribers
300 photos

Главный инструмент стримера!

About
Blog
Apps
Platform

DonationAlerts
5.19K subscribers

This media is not supported in your browser

Подготовили для вас новое предложение: в store.my.games появилась игра Breathedge. С каждой продажи вы получите 65 рублей.

Breathedge — это игра про обычного парня, который ехал на космические похороны дедушки, а в итоге ему самому пришлось выживать в космосе. Игроков ждет отличная история, много чёрного юмора и полное соблюдение законов физики (попробуйте поиграть на пианино в открытом космосе)��

Рекламное предложение можно принять в вашем личном кабинете DonationAlerts.
https://www.donationalerts.com/dashboard/offers

Синтез Речи 2.0 | Озвучка донатов Кубик в Кубе

Старые голоса озвучки донатов вам надоели? Хотите новых впечателний на своих стримах?
DonationAlerts, совместно с компанией Vera Voice представляют вам:
Синтез речи 2.0
Теперь ваши зрители смогут:
1) Выбрать язык озвучки
2) Выбрать голос озвучки
3) Использовать…

С 16 июля выключаем старый виджет сбора средств — будет работать только новый!

Сразу успокоим: данные о текущем сборе средств никуда не пропадут даже после отключения. Вы можете перенести их в новый виджет в любое время.

Ну и самое приятное. У тех, кто уже подключил виджет 2.0, донаты выросли аж на 80%. А еще там больше возможностей для кастомизации и приятный дизайн ����

Триумфальное возвращение PayPal уже сегодня! Работает на ввод и на вывод, все летает как в старые добрые, когда еще были самолеты.

DonationAlerts

�� Озвучка донатов «Кубик в кубе» теперь доступна всем!��

Будущее наступило — робот читает сообщения голосом Руслана Габидуллина. Лучше сами посмотрите подборку, текстом это великолепие не передать.

Включайте озвучку в настройках синтеза речи вашего виджета оповещений, порадуйте себя и зрителей ��

Реакция стримеров Twitch на озвучку донатов Кубик в Кубе. | JesusAVGN, Olyashaa, Wprotvbanke и др

Некоторое время назад мы анонсировали Синтез Речи 2.0 с озвучкой донатов голосом Кубик в Кубе - Русланом Габидуллиным. Первые стримеры уже попробовали новую озвучку. Их реакция показалась нам очень забавной и мы решили поделиться ею с вами. Кстати, новый…

568 views edited 10:14

Отличное обновление для тех, кто проводит трансляции на нескольких платформах одновременно. Теперь вы можете удобно общаться с аудиторией, не пропуская сообщения из чатов на Twitch, YouTube, VK и других стриминговых сервисах.

Выводить мультичат на трансляцию с помощью виджета тоже можно: так зрители смогут видеть, что вам пишут на других платформах.

Заходите проверять новинку в личный кабинет, быстрая ссылка:
https://www.donationalerts.com/dashboard/multichat

Марафон обновлений продолжается! На этой неделе их так много, что мы решили записать видео, чтобы не пугать вас простыней текста.

Если коротко: мультичат работает, Mixer не работает, а еще у нас новая озвучка от Стьюи из Filiza Studio и оповещения на Twitch. Да, за действия с баллами канала тоже.

О всех результатах многомесячной работы рассказываем за три с половиной минуты: https://youtu.be/yb_jehlkEOY

Обновление: виджет Мультичата, Новые Уведомления Twitch, Озвучка донатов от Filiza Studio

Несколько месяцев наша команда упорно работала и сегодня мы хотим представить несколько полезных новых фишек0:00 - начало0:27 - виджет мультичата0:53 - прекр.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *