Notell API Docs
English

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

Основные понятия

Проект (partner)#

Проект — ваша интеграция на платформе. Он определяется идентификатором partner и включает:

  • API-ключ (api_key): передаётся в теле ваших запросов и возвращается в каждом колбэке кошелька;
  • URL колбэка — endpoint вашего кошелька;
  • список IP ваших серверных сетей;
  • разрешённые источники iframe: сайты, которым разрешено встраивать игру (Встраивание);
  • настройки: валюта и язык по умолчанию, включённые провайдеры и функции, лимиты ставок, RTP.

Проект создаёт владелец платформы и выдаёт вам идентификатор partner и API-ключ. Дальше ваши сотрудники работают с проектом в админ-панели.

Режим с кошельком и демо-режим#

Любую игру можно запустить двумя способами; выбор делает gametype в Запуске игры:

РежимgametypeДеньги
Режим с кошельком"demo"Сессия играет на ваш кошелёк через колбэки кошелька. Значение называется demo по историческим причинам.
Демо-режим"fun"Бесплатная игра на изолированном демо-кошельке; ваш кошелёк не вызывается, в ваши отчёты ничего не попадает. См. Демо-режим.

Игрок#

Игрок — тот, кого вы идентифицируете через player_id: строка из 1–128 печатных ASCII-символов, которую выбираете вы. Платформа считает player_id непрозрачным ключом в запуске, колбэках кошелька, фриспинах, целевых исходах и RTP.

Валюта и деньги#

Платформа принимает все 157 фиатных валют ISO 4217 и для каждой использует два знака после запятой. Список и то, что не поддерживается, — на странице Валюты.

Суммы встречаются в трёх формах в зависимости от места:

ГдеФормаПример для 12.50
Колбэки кошелька (amount, balance)JSON-число в единицах валюты12.50
Фриспины (bet, total_win), отчёты, demo_balanceдесятичная строка в единицах валюты"12.50"
Лимиты (min_minor, max_minor) и API админкиминорные единицы строкой (1/100 единицы)"1250"

Точные правила (знаки после запятой, количество цифр, как платформа записывает числа) — в Соглашениях.

Сессия#

Запуск игры создаёт сессию, привязанную к игроку, игре, валюте и языку. В ответе приходят meta.session_id и link с токеном сессии; передавайте его только этому игроку. Сессия истекает через 2 часа после создания; повторный запуск при незавершённом раунде возобновляет её, чтобы раунд можно было закончить.

Раунд#

Раунд — один платный игровой цикл (спин и всё, что он запускает: бесплатные игры, бонусные раунды, гэмбл). Платформа проводит каждый раунд через такие шаги:

  1. платформа просит ваш кошелёк списать ставку (bet);
  2. после подтверждения списания она отправляет round_info со status: "start";
  3. исход разыгрывается в игре;
  4. если раунд выиграл, платформа просит кошелёк начислить выигрыш (win);
  5. после подтверждения начисления она отправляет round_info со status: "finish".

Если кошелёк отказал в списании, раунд отклоняется и ничего не разыгрывается. Начатый раунд никогда не теряется: перезагрузка или повторный запуск продолжают его. Раунды фриспинов идут по тому же потоку со ставкой 0, но их выигрыши выплачиваются один раз в конце выдачи: см. Фриспины и win.

Провайдеры, игры и режимы#

Игры относятся к одному из трёх семейств провайдеров (endorphina, pragmatic, nolimitcity). Игра определяется своим идентификатором (symbol в запросе запуска, game_id в каталоге). У каждой игры есть базовый режим (spin), могут быть и другие: покупка бонуса, анте-ставка или гэмбл; необязательные режимы включаются и выключаются по провайдерам в настройках проекта.

Что ещё привязано к игроку#

ОбъектНазначениеСтраница
Выдача фриспиновКоличество спинов с фиксированной ставкой, выданных операторомФриспины
Целевой исходЗапланированный результат одного из платных спинов игрокаЦелевые исходы
Персональный RTPУровень возврата игроку, применяемый к его раундамУправление RTP
Лимит ставок игрокаПерсональные минимальная / максимальная ставка по валютеЛимиты ставок
Документация для операторов и интеграторов.Платформа TEST_ONLY: невыводимые единицы, реальные платежи не используются.