QQ.v1 (1.0)

Download OpenAPI specification:

Обзор

Фильтры и пагинация

Методы API, помеченные SEARCHABLE могут принимать параметры фильтрации и разбивки выдачи на страницы. Пример формирования query string фильтров:

SELECT [...] 
WHERE 
      created >= '2020-06-01' 
  AND created <= '2020-06-30'
  AND operation IN ('RESERVE', 'SELL')
//created[ge]=2020-06-01&created[le]=2020-06-30&operation[eq][]=RESERVE&operation[eq][]=SELL

var qs = require('qs');

const filter = {
  created: {
    ge: '2020-06-01',
    le: '2020-06-30',
  },
  operation: {
    eq: ['RESERVE', 'SELL'],
  }
};

function format(c){
    console.log(qs.stringify(filter, {...c, encode: false, allowDots: false }));
}

format({ arrayFormat: 'brackets' });
SELECT [...] 
WHERE 
     nickname LIKE 'test%'
  OR phone    LIKE '7900%'
//-or[phone][like]=7900%&-or[nickname][like]=test%
[...] 
const filter = { 
  '-or': {
     phone:    { like: '7900%' } ,
     nickname: { like: 'test%' }, 
   } 
};
[...]

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

  {
    eq      => '=',     # точное совпадение
    ne      => '!=',    # исключение
    lt      => '<',     # меньше
    gt      => '>',     # больше
    le      => '<=',    # меньше или равно
    ge      => '>=',    # больше или равно
    like    => 'LIKE',  # поиск по подстроке
    ilike   => 'ILIKE', # поиск по подстроке без учета регистра
    inArray => '&&',    # поиск в массиве
  }

Параметры пагинации указаны в описании метода.

Справочники

Справочники

Поиск наград Deprecated

SEARCHABLE Поиск наград

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "awards": [
    ],
  • "records": 2147483647
}

Поиск наград

SEARCHABLE Поиск наград

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "awards": [
    ],
  • "records": 2147483647
}

Поиск рекордов

SEARCHABLE Поиск наград

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "records": 2147483647
}

Поиск владельцев рекордов Deprecated

SEARCHABLE Поиск рекордов

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "records": 2147483647
}

Поиск владельцев рекордов

SEARCHABLE Поиск рекордов

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "records": 2147483647
}

Поиск достижений

SEARCHABLE Поиск достижений

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "ratings": [
    ],
  • "records": 2147483647
}

Список цветов

SEARCHABLE Список цветов

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "colors": [
    ],
  • "records": 2147483647
}

Пожаловаться

Пожаловаться на контент

Authorizations:
password
Request Body schema: application/json
required
user_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

team_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

object

Responses

Request samples

Content type
application/json
{
  • "user_id": 2147483647,
  • "team_id": 2147483647,
  • "feedback": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Список городов

SEARCHABLE Список городов

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "cities": [
    ],
  • "records": 2147483647
}

Конфигурация приложения

Конфигурация приложения

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "min_app_version": "strings"
}

Пользователи

Пользователи

Поиск игр

SEARCHABLE Поиск игр

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "games": [
    ],
  • "records": 2147483647
}

Регистрация

Регистрация

Authorizations:
password
Request Body schema: application/json
required
phone
required
string (Phone) [ 7 .. 15 ] characters ^\d{7,15}$

Номер телефона

nickname
string or null (Nickname) [ 3 .. 32 ] characters ^[\][A-Za-z.А-Яа-яЁё_=-]+[\][*A-Za-z0-9.А-Яа-...

Ник

password
string [ 2 .. 32 ] characters [\p{Print}]*

Пароль

referrer
string or null [ 2 .. 11 ] characters ^[A-Za-z]{2,}$|^\d{7,15}$

Реферальный код

city_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

notify
boolean or null
Default: false

Получать уведомления от сервиса.

tg_data
string or null [ 0 .. 8192 ] characters [\p{Print}]*

Данные пользователя при авторизации через Telegram.

channel
string
Enum: "flashCall" "sms"

Желаемый канал передачи кода подверждения.

Responses

Request samples

Content type
application/json
{
  • "phone": "79123456789",
  • "nickname": "crux",
  • "password": "string",
  • "referrer": "string",
  • "city_id": 2147483647,
  • "notify": false,
  • "tg_data": "string",
  • "channel": "flashCall"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Профиль пользователя

Профиль пользователя

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "phone": "79123456789",
  • "nickname": "crux",
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "balance": -1000000,
  • "phone_code": 1000,
  • "refcode": "string",
  • "referrer": {
    },
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "notify": false,
  • "delete_me": "2019-08-24T14:15:22Z",
  • "stat": {
    },
  • "active": true,
  • "vk_profile": {
    },
  • "has_password": false,
  • "settings": {
    },
  • "rdb_token": "string"
}

Профиль пользователя

Профиль пользователя

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "phone": "79123456789",
  • "nickname": "crux",
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "balance": -1000000,
  • "phone_code": 1000,
  • "refcode": "string",
  • "referrer": {
    },
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "notify": false,
  • "delete_me": "2019-08-24T14:15:22Z",
  • "stat": {
    },
  • "active": true,
  • "vk_profile": {
    },
  • "has_password": false,
  • "settings": {
    },
  • "rdb_token": "string"
}

Обновление профиля

Обновление профиля пользователя

Authorizations:
password
Request Body schema: application/json
required
nickname
string or null (Nickname) [ 3 .. 32 ] characters ^[\][A-Za-z.А-Яа-яЁё_=-]+[\][*A-Za-z0-9.А-Яа-...

Ник

password
string <password> [ 2 .. 32 ] characters .{2,32}

Пароль

city_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

notify
boolean
Default: false

Получать уведомления от сервиса.

delete_me
boolean

true - запрашивается удаление аккаунта.

fcm_token
string [ 0 .. 1024 ] characters

FCM Token

object or null (VKProfile)
referrer
string or null [ 2 .. 11 ] characters ^[A-Za-z]{2,}$

Реферальный код

object or null (UserSettings)

Пользовательские настройки.

Responses

Request samples

Content type
application/json
{
  • "nickname": "crux",
  • "password": "pa$$word",
  • "city_id": 2147483647,
  • "notify": false,
  • "delete_me": true,
  • "fcm_token": "string",
  • "vk_profile": {
    },
  • "referrer": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "phone": "79123456789",
  • "nickname": "crux",
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "balance": -1000000,
  • "phone_code": 1000,
  • "refcode": "string",
  • "referrer": {
    },
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "notify": false,
  • "delete_me": "2019-08-24T14:15:22Z",
  • "stat": {
    },
  • "active": true,
  • "vk_profile": {
    },
  • "has_password": false,
  • "settings": {
    },
  • "rdb_token": "string"
}

Профиль по никнейму

Получить профиль пользователя по никнейму. Может быть использован для проверки уникальности никнейма.

Authorizations:
password
path Parameters
nickname
required
string [ 3 .. 32 ] characters ^[\][A-Za-z0-9.А-Яа-яЁё_=-]+[\][*A-Za-z0-9.А-...
Example: crux

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "nickname": "crux",
  • "balance": -1000000,
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "refcode": "string",
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "stat": {
    },
  • "referrer": {
    },
  • "phone": "79123456789",
  • "active": true
}

Проверка номера телефона

Проверка уникальности номера телефона.

Authorizations:
password
path Parameters
phone
required
string [ 7 .. 15 ] characters ^\d{7,15}$
Example: 79123456789

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "nickname": "crux",
  • "balance": -1000000,
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "refcode": "string",
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "stat": {
    },
  • "referrer": {
    },
  • "phone": "79123456789",
  • "active": true
}

Профиль по рефкоду

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

Authorizations:
password
path Parameters
refcode
required
string [ 2 .. 11 ] characters ^[A-Za-z]{2,}$|^\d{7,15}$

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "nickname": "crux",
  • "balance": -1000000,
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "refcode": "string",
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "stat": {
    },
  • "referrer": {
    },
  • "phone": "79123456789",
  • "active": true
}

Подтверждение номера

Подтверждение номера телефона кодом из SMS

Authorizations:
password
Request Body schema: application/json
required
code
required
integer <int32> (SMSCode) [ 1000 .. 9999 ]

Код из SMS

Responses

Request samples

Content type
application/json
{
  • "code": 1234
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "phone": "79123456789",
  • "nickname": "crux",
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "balance": -1000000,
  • "phone_code": 1000,
  • "refcode": "string",
  • "referrer": {
    },
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "notify": false,
  • "delete_me": "2019-08-24T14:15:22Z",
  • "stat": {
    },
  • "active": true,
  • "vk_profile": {
    },
  • "has_password": false,
  • "settings": {
    },
  • "rdb_token": "string"
}

Награды

SEARCHABLE Список наград

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "awards": [
    ],
  • "records": 2147483647
}

Рейтинги

SEARCHABLE Список рейтингов

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "ratings": [
    ],
  • "records": 2147483647
}

Рекорды

SEARCHABLE Список рекордов

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "records": 2147483647
}

Промокоды

SEARCHABLE Список сохранённых промокодов

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "promocodes": [
    ],
  • "records": 2147483647
}

Привязка промокода

Привязка промокода к учётной записи.

Authorizations:
password
Request Body schema: application/json
promocode
required
string or null (Promocode) [ 1 .. 64 ] characters [A-Za-zА-Яа-яЁё0-9-.]+

Промокод

Responses

Request samples

Content type
application/json
{
  • "promocode": "NEWBIE"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Обмен VKactive

Обмен VKactive на промокод.

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "logic": "regex",
  • "args": {
    },
  • "id": 2147483647,
  • "code": "NEWBIE",
  • "link": "player",
  • "factor": 1,
  • "fixed": 1000000,
  • "limit_factor": 1,
  • "from_date": "2019-08-24",
  • "to_date": "2019-08-24",
  • "count": 1,
  • "used": 1000000,
  • "team": "string",
  • "team_id": 2147483647,
  • "user": "string",
  • "public_use": 1,
  • "public_used": 1000000,
  • "expired": false,
  • "details": "string",
  • "franchise": {
    }
}

Передача промокода

Передача промокода другому игроку.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
to
required
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

Responses

Request samples

Content type
application/json
{
  • "to": 2147483647
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Перевод средств

Перевод средств другому участнику

Authorizations:
password
Request Body schema: application/json
required
amount
required
number <float> [ 1 .. 1000000 ]

Сумма пополнения

to
required
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

ID получателя.

Responses

Request samples

Content type
application/json
{
  • "amount": 1,
  • "to": 2147483647
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

История заказов

SEARCHABLE История баланса

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "records": 2147483647
}

Запрос на вывод средств

Создаёт запрос на вывод средств.

Authorizations:
password
Request Body schema: application/json

Параметры вывода.

amount
number <float> [ 1000 .. 1000000 ]

Сумма вывода.

Responses

Request samples

Content type
application/json
{
  • "amount": 1000
}

Response samples

Content type
application/json
{ }

Отправка кода подтверждения.

Отправка номера для которого нужно повторить отправку кода подтверждения операции.

Authorizations:
password
Request Body schema: application/json
phone
required
string (Phone) [ 7 .. 15 ] characters ^\d{7,15}$

Номер телефона

channel
required
string
Enum: "sms" "flashCall"

Responses

Request samples

Content type
application/json
{
  • "phone": "79123456789",
  • "channel": "sms"
}

Response samples

Content type
application/json
{
  • "phone_code": 1234
}

Повторная отправка SMS. Deprecated

Отправка номера для которого нужно повторить отправку кода подтверждения операции.

Authorizations:
password
Request Body schema: application/json
phone
required
string (Phone) [ 7 .. 15 ] characters ^\d{7,15}$

Номер телефона

Responses

Request samples

Content type
application/json
{
  • "phone": "79123456789"
}

Response samples

Content type
application/json
{
  • "phone_code": 1234
}

Восстановление пароля. Шаг 1. Deprecated

Отправка номера для которого нужно восстановить пароль.

Authorizations:
password
Request Body schema: application/json
phone
required
string (Phone) [ 7 .. 15 ] characters ^\d{7,15}$

Номер телефона

Responses

Request samples

Content type
application/json
{
  • "phone": "79123456789"
}

Response samples

Content type
application/json
{
  • "phone_code": 1234
}

Восстановление пароля. Шаг 2. Deprecated

Проверка кода из SMS.

Authorizations:
password
Request Body schema: application/json
phone
required
string (Phone) [ 7 .. 15 ] characters ^\d{7,15}$

Номер телефона

phone_code
required
integer <int32> (SMSCode) [ 1000 .. 9999 ]

Код из SMS

Responses

Request samples

Content type
application/json
{
  • "phone": "79123456789",
  • "phone_code": 1234
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Восстановление пароля. Шаг 3. Deprecated

Установка нового пароля.

Authorizations:
password
Request Body schema: application/json
phone
required
string (Phone) [ 7 .. 15 ] characters ^\d{7,15}$

Номер телефона

phone_code
required
integer <int32> (SMSCode) [ 1000 .. 9999 ]

Код из SMS

password
required
string [ 2 .. 32 ] characters [\p{Print}]*

Новый пароль

Responses

Request samples

Content type
application/json
{
  • "phone": "79123456789",
  • "phone_code": 1234,
  • "password": "1234Qq"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Обновление аватара

Загрузка аватара игрока

Authorizations:
password
Request Body schema: multipart/form-data
required

Аватар игрока

string <binary> [ 0 .. 5242880 ] characters (\w|\W)*

Responses

Response samples

Content type
application/json
{ }

Заявки на вывод

SEARCHABLE Список заявок на вывод.

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "records": 2147483647
}

Детализация активности

Детализация текущей активности и история изменения.

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "globals": {
    },
  • "player": {
    },
  • "author": { },
  • "log": [
    ]
}

Список операций баланса

SEARCHABLE Список операций по балансу кукух.

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "log": [
    ],
  • "records": 2147483647
}

Отмена заявки на вывод.

Отмена заявки на вывод.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Список партнёров

SEARCHABLE Список партнёров, под приглашениями пользователя, с суммарной информацией о полученных кукухах.

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "referrals": [
    ],
  • "records": 2147483647
}

Команды

Команды

Поиск команд

SEARCHABLE Поиск команд

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "teams": [
    ],
  • "records": 2147483647
}

Создание команды

Создание команды

Authorizations:
password
Request Body schema: application/json
required
name
required
string [ 3 .. 64 ] characters [\p{Print}]*

Название команды

active
boolean
Default: true

Отображается при поиске.

checked
boolean
Default: false

Отметка команды. Проставляется автором в рамках игры.

avatar
string or null <uri> (URL) [ 0 .. 2048 ] characters ^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[%\w...
Array of objects or null (Id_Nickname) [ 0 .. 100 ] items

Состав команды на игре

deferred_pay
boolean
Default: false

Отложенная оплата

slots
integer [ 0 .. 100 ]

Количество оплаченных слотов при тарификации за игрока.

had_game_access
integer or null <int32> [ 0 .. 100 ]

Количество игроков, имевших доступ к игре во время проведения.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "checked": false,
  • "avatar": "http://example.com",
  • "lineup": [
    ],
  • "deferred_pay": false,
  • "slots": 100,
  • "had_game_access": 100
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "captain": 2147483647,
  • "active": true,
  • "created": "2019-08-24T14:15:22Z",
  • "checked": false,
  • "test": false,
  • "stat": {
    },
  • "avatar": "http://example.com",
  • "deletable": true,
  • "transferable": true,
  • "running": false,
  • "closed": false,
  • "finished": false,
  • "main_run": true,
  • "place": 1000000,
  • "lineup": [
    ],
  • "deferred_pay": false,
  • "slots": 100,
  • "promocode": {
    },
  • "had_game_access": 100
}

Передача команды

Передача команды другому игроку.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
captain
required
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

Responses

Request samples

Content type
application/json
{
  • "captain": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "captain": 2147483647,
  • "active": true,
  • "created": "2019-08-24T14:15:22Z",
  • "checked": false,
  • "test": false,
  • "stat": {
    },
  • "avatar": "http://example.com",
  • "deletable": true,
  • "transferable": true,
  • "running": false,
  • "closed": false,
  • "finished": false,
  • "main_run": true,
  • "place": 1000000,
  • "lineup": [
    ],
  • "deferred_pay": false,
  • "slots": 100,
  • "promocode": {
    },
  • "had_game_access": 100
}

Обновление аватара

Загрузка аватара команды

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: multipart/form-data
required

Аватар команды

string <binary> [ 0 .. 5242880 ] characters (\w|\W)*

Responses

Response samples

Content type
application/json

Информация о команде

Информация о команде

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
game_id
integer <int32> [ 1 .. 2147483647 ]

ID квеста для получения состава команды

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "captain": 2147483647,
  • "active": true,
  • "created": "2019-08-24T14:15:22Z",
  • "checked": false,
  • "test": false,
  • "stat": {
    },
  • "avatar": "http://example.com",
  • "deletable": true,
  • "transferable": true,
  • "running": false,
  • "closed": false,
  • "finished": false,
  • "main_run": true,
  • "place": 1000000,
  • "lineup": [
    ],
  • "deferred_pay": false,
  • "slots": 100,
  • "promocode": {
    },
  • "had_game_access": 100
}

Редактирование команды

Редактирование команды

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
name
required
string [ 3 .. 64 ] characters [\p{Print}]*

Название команды

active
boolean
Default: true

Отображается при поиске.

checked
boolean
Default: false

Отметка команды. Проставляется автором в рамках игры.

avatar
string or null <uri> (URL) [ 0 .. 2048 ] characters ^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[%\w...
Array of objects or null (Id_Nickname) [ 0 .. 100 ] items

Состав команды на игре

deferred_pay
boolean
Default: false

Отложенная оплата

slots
integer [ 0 .. 100 ]

Количество оплаченных слотов при тарификации за игрока.

had_game_access
integer or null <int32> [ 0 .. 100 ]

Количество игроков, имевших доступ к игре во время проведения.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "checked": false,
  • "avatar": "http://example.com",
  • "lineup": [
    ],
  • "deferred_pay": false,
  • "slots": 100,
  • "had_game_access": 100
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "captain": 2147483647,
  • "active": true,
  • "created": "2019-08-24T14:15:22Z",
  • "checked": false,
  • "test": false,
  • "stat": {
    },
  • "avatar": "http://example.com",
  • "deletable": true,
  • "transferable": true,
  • "running": false,
  • "closed": false,
  • "finished": false,
  • "main_run": true,
  • "place": 1000000,
  • "lineup": [
    ],
  • "deferred_pay": false,
  • "slots": 100,
  • "promocode": {
    },
  • "had_game_access": 100
}

Удаление команды

Удаление команды. Удалять можно только команды с признаком deletable.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Свои команды

SEARCHABLE Список своих команд

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "teams": [
    ],
  • "records": 2147483647
}

Игры

Игры

Game

id
required
integer <int32> (Id) [ 0 .. 2147483647 ]

Id

city_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

object or null (City)

Город

name
required
string [ 3 .. 180 ] characters [\p{Print}]*

Название игры

schema
string
Default: "LINEAR"
Enum: "LINEAR" "RANDOM" "ALL" "CUSTOM"

Схема выдачи заданий.

LINEAR
Уровни следуют один за другим. В каждый момент времени открыт только один, текущий уровень.

RANDOM
Уровни выдаются случайно для каждой команды. По возможности выдаётся уровень, на котором нет команд или который потенциально скоро освободится. В каждый момент времени открыт только один, текущий уровень.

ALL
Открываются сразу все игровые уровни.

CUSTOM
Схема игры настраивается автором вручную.

start
required
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

enroll_until
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

description
string or null [ 0 .. 32768 ] characters [\p{Print}]*

Описание игры

social_text
string or null [ 0 .. 16384 ] characters [\p{Print}]*

Текст для соцсетей

timing
string or null [ 0 .. 64 ] characters [\p{Print}]*

Ожидаемое время прохождения.

timing_for
string or null [ 0 .. 64 ] characters [\p{Print}]*

На кого рассчитано ожидаемое время прохождения

mileage
integer or null <int32> [ 0 .. 40075 ]

Минимальный пробег на игре в километрах.

max_players
required
integer <int32> [ 1 .. 100 ]

Максимальное количество игроков в команде.

cost
required
number <float> [ 0 .. 1000000 ]

Стоимость участия в рублях.

cost_qq
number or null <float> [ 0 .. 1000000 ]

Сумма, которая будет оплачена кукухами.

cost_loyalty
number or null <float> [ 0 .. 1000000 ]
Deprecated

Стоимость с учетом оплаты кукухами.

cost_discounted
number or null <float> [ 0 .. 1000000 ]

Стоимость со скидкой за раннюю регистрацию

cost_discounted_end
string or null <date-time> (DateTimeTZ-RO) <= 34 characters

Дата и время, с таймзоной, только чтение

tags
required
Array of strings (GameTag) [ 1 .. 7 ] items unique
Items Enum: "PHOTO" "BRAIN" "COMBAT" "SNOOP" "TOUR" "MAZE" "STREET" "URBAN"

Типы игры

transport
required
string (GameTransport)
Enum: "NONE" "ANY" "CAR" "FOOT" "BIKE"

Средство передвижения

created
required
string or null <date-time> (DateTimeTZ-RO) <= 34 characters

Дата и время, с таймзоной, только чтение

owner
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

Array of objects (GameAuthor) [ 0 .. 32 ] items unique
briefing_geo
string or null (GeoPoint) [ 5 .. 26 ] characters ^\((-?\d+\.\d+),(-?\d+\.\d+)\)$

Точка на карте

briefing_time
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

briefing_txt
string or null [ 0 .. 1024 ] characters [\p{Print}]*

Место предыгрового брифинга

published
boolean
Default: false

Игра доступна для поиска и регистрации.

score
number or null <float> [ 0 .. 5 ]

Средняя оценка.

uuid
string <uuid> = 36 characters ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

Уникальный идентификатор игры

splash
string or null <uri> [ 0 .. 2000 ] characters ^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[%\w...

Ссылка на картинку анонса

start_type
string
Default: "auto"
Enum: "manual" "auto" "team"

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

Array of objects or null (GameHint) [ 0 .. 32 ] items

Раздел подготовки к квесту.

testing
required
boolean
Default: false

Запущено тестирование автором.

running
required
boolean
Default: false

Игра запущена

start_in
required
integer <int32> [ 0 .. 2147483647 ]

Время в секундах, через которое стартует игра

enroll_closes_in
integer or null <int32> [ 0 .. 2147483647 ]

Время в секундах, через которое закрывается регистрация, если она ограничена.

object or null (Team)

Команда

object or null (GameFeedback)
Array of objects or null (Id_Nickname) [ 0 .. 1000 ] items unique

Состав команды

Array of objects or null (Team) [ 0 .. 1000 ] items

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

teams_count
integer <int32> [ 0 .. 1000000 ]

Количество команд, принявших участие.

teams_limit
integer or null <int32> [ 0 .. 1024 ]

Максимальное количество команд.

started_ago
required
integer <int32> [ 0 .. 2147483647 ]

Количество секунд, прошедших со старта квеста.

closed
boolean

Игра закрыта

closed_at
string or null <date-time> (DateTimeTZ-RO) <= 34 characters

Дата и время, с таймзоной, только чтение

Array of objects or null (GameMetricAvg) = 3 items

Итоговые оценки за квест по критериям.

stat
string (GameStatVisibility)
Enum: "VISIBLE" "OWN" "PASSED" "HIDDEN"

Видимость статистики

rank_type
string (GameRankType)
Enum: "TIME" "LEVELS" "GAME" "CUSTOM" "SCORE"

Метод расстановки мест.

rank_value
string (GameRankValue)
Enum: "TIME" "SCORE"

Игра на время или на баллы.

objectivity
number or null <float> [ 0 .. 1 ]

Доля поставивших оценку.

rank_var_1
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_1
string or null (GameRankSort)
Enum: "ASC" "DESC"
rank_var_2
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_2
string or null (GameRankSort)
Enum: "ASC" "DESC"
early_birds_global
boolean or null
Default: true

Применяются глобальные настройки скидок за раннюю регистрацию.

screenplay_public
boolean or null
Default: true

Просмотр сценария доступен игрокам после закрытия игры.

object or null (GameSocialMessagingData)

Данные для каналов оповещения. Доступно для автора.

object (RDBTimestamp)
charge_type
string (GameChargeType)
Enum: "TEAM" "PLAYER"

Оплата за участника или за команду.

franchise_id
integer or null <int32> (Id-nullable) [ 0 .. 2147483647 ]

Id-nullable

payment_methods
Array of strings or null (PaymentType) [ 0 .. 100 ] items
Enum: "sberbank" "tochka" "yoomoney" "cash"
object or null (BalanceLogItemOrder)

Данные заказа регистрации.

{
  • "id": 2147483647,
  • "city": {
    },
  • "name": "This Is The Game",
  • "schema": "LINEAR",
  • "start": "2019-08-24T14:15:22Z",
  • "enroll_until": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "social_text": "string",
  • "timing": "2-4 hours",
  • "timing_for": "Leaders",
  • "mileage": 50,
  • "max_players": 1,
  • "cost": 1500,
  • "cost_qq": 1000000,
  • "cost_loyalty": 1000000,
  • "cost_discounted": 1000000,
  • "cost_discounted_end": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "transport": "NONE",
  • "created": "2019-08-24T14:15:22Z",
  • "owner": 2147483647,
  • "authors": [
    ],
  • "briefing_geo": "(56.129129,40.408397)",
  • "briefing_time": "2019-08-24T14:15:22Z",
  • "briefing_txt": "string",
  • "published": false,
  • "score": 5,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "splash": "http://example.com",
  • "start_type": "manual",
  • "hints": [
    ],
  • "testing": false,
  • "running": false,
  • "start_in": 2147483647,
  • "enroll_closes_in": 2147483647,
  • "team": {
    },
  • "feedback": {
    },
  • "lineup": [
    ],
  • "teams": [
    ],
  • "teams_count": 1000000,
  • "teams_limit": 1024,
  • "started_ago": 2147483647,
  • "closed": true,
  • "closed_at": "2019-08-24T14:15:22Z",
  • "metrics": [
    ],
  • "stat": "VISIBLE",
  • "rank_type": "TIME",
  • "rank_value": "TIME",
  • "objectivity": 1,
  • "rank_var_1": 2147483647,
  • "rank_sort_1": "ASC",
  • "rank_var_2": 2147483647,
  • "rank_sort_2": "ASC",
  • "early_birds_global": true,
  • "screenplay_public": true,
  • "social_messaging": {
    },
  • "saved_at": {
    },
  • "charge_type": "TEAM",
  • "franchise_id": 2147483647,
  • "payment_methods": [
    ],
  • "order": {
    }
}

Поиск игр

SEARCHABLE Поиск игр

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "games": [
    ],
  • "records": 2147483647
}

Календарь игр

Календарь игр

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "games": [
    ]
}

Информация об игре

Информация об игре

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "city": {
    },
  • "name": "This Is The Game",
  • "schema": "LINEAR",
  • "start": "2019-08-24T14:15:22Z",
  • "enroll_until": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "social_text": "string",
  • "timing": "2-4 hours",
  • "timing_for": "Leaders",
  • "mileage": 50,
  • "max_players": 1,
  • "cost": 1500,
  • "cost_qq": 1000000,
  • "cost_loyalty": 1000000,
  • "cost_discounted": 1000000,
  • "cost_discounted_end": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "transport": "NONE",
  • "created": "2019-08-24T14:15:22Z",
  • "owner": 2147483647,
  • "authors": [
    ],
  • "briefing_geo": "(56.129129,40.408397)",
  • "briefing_time": "2019-08-24T14:15:22Z",
  • "briefing_txt": "string",
  • "published": false,
  • "score": 5,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "splash": "http://example.com",
  • "start_type": "manual",
  • "hints": [
    ],
  • "testing": false,
  • "running": false,
  • "start_in": 2147483647,
  • "enroll_closes_in": 2147483647,
  • "team": {
    },
  • "feedback": {
    },
  • "lineup": [
    ],
  • "teams": [
    ],
  • "teams_count": 1000000,
  • "teams_limit": 1024,
  • "started_ago": 2147483647,
  • "closed": true,
  • "closed_at": "2019-08-24T14:15:22Z",
  • "metrics": [
    ],
  • "stat": "VISIBLE",
  • "rank_type": "TIME",
  • "rank_value": "TIME",
  • "objectivity": 1,
  • "rank_var_1": 2147483647,
  • "rank_sort_1": "ASC",
  • "rank_var_2": 2147483647,
  • "rank_sort_2": "ASC",
  • "early_birds_global": true,
  • "screenplay_public": true,
  • "social_messaging": {
    },
  • "saved_at": {
    },
  • "charge_type": "TEAM",
  • "franchise_id": 2147483647,
  • "payment_methods": [
    ],
  • "order": {
    }
}

Информация о стоимости Deprecated

Информация о стоимости

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "cost": 1500,
  • "cost_qq": 1000000,
  • "cost_loyalty": 1000000,
  • "cost_discounted": 1000000,
  • "cost_discounted_end": "2019-08-24T14:15:22Z"
}

Информация о видеопотоке

Информация о видеопотоке

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

video_id
required
string <uuid> [ 1 .. 2147483647 ]

video_id

Responses

Response samples

Content type
application/json
{}

Информация о стоимости

Информация о стоимости

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
promocode
string or null (Promocode) [ 1 .. 64 ] characters [A-Za-zА-Яа-яЁё0-9-.]+

Промокод

team_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

players
integer <int32> [ 1 .. 100 ]

Количество оплачиваемых мест для игроков в составе при оплате за игрока.

Responses

Request samples

Content type
application/json
{
  • "promocode": "NEWBIE",
  • "team_id": 2147483647,
  • "players": 1
}

Response samples

Content type
application/json
{
  • "full": 1500,
  • "qq": 1000000,
  • "discounted": 1000000,
  • "early_birds_data": {
    },
  • "usable": true,
  • "promocode_id": 2147483647,
  • "promocode_expired": false,
  • "players": 1
}

Отзывы и оценки игры

SEARCHABLE Отзывы и оценки игры.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "feedbacks": [
    ],
  • "records": 2147483647
}

Свои игры Deprecated

SEARCHABLE Список предстоящих игр на которые игрок зарегистрирован как капитан команды

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "games": [
    ],
  • "records": 2147483647
}

Составы команд на игре

SEARCHABLE Составы команд на игре

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "lineups": [
    ],
  • "records": 2147483647
}

Регистрация / состав команды

Регистрация на игру, редактирование состава команды

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
is_mobile
boolean
Default: false

Использовать мобильные страницы для возврата из банка.

theme
string
Default: "dark"
Enum: "dark" "light"

Тема для страницы возврата

Request Body schema: application/json
required
team_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

lineup
required
Array of integers or null <int32> (Id-rw) [ 0 .. 100 ] items unique [ items <int32 > [ 0 .. 2147483647 ] ]

Список ID игроков

promocode
string (Promocode-WO) [ 1 .. 64 ] characters [A-Za-zА-Яа-яЁё0-9-.]+

Промокод

pay_by
string (PaymentType)
Enum: "sberbank" "tochka" "yoomoney" "cash"
deferred_pay
boolean
Default: false
players
integer <int32> [ 1 .. 100 ]
Default: 1

Количество игроков при оплате за человека.

Responses

Request samples

Content type
application/json
{
  • "team_id": 2147483647,
  • "lineup": [
    ],
  • "promocode": "NEWBIE",
  • "pay_by": "sberbank",
  • "deferred_pay": false,
  • "players": 1
}

Response samples

Content type
application/json
{
  • "team_id": 2147483647,
  • "lineup": [
    ],
  • "pay_by": "sberbank",
  • "deferred_pay": false,
  • "players": 1
}

Проверка стоимости при регистрации Deprecated

Проверка промокода при регистрации команды на игру

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
promocode
string or null (Promocode) [ 1 .. 64 ] characters [A-Za-zА-Яа-яЁё0-9-.]+

Промокод

team_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

players
integer <int32> [ 1 .. 100 ]

Количество оплачиваемых мест для игроков в составе при оплате за игрока.

Responses

Request samples

Content type
application/json
{
  • "promocode": "NEWBIE",
  • "team_id": 2147483647,
  • "players": 1
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "cost": 1500,
  • "loyalty": 1500,
  • "qq": 1500,
  • "discounted": 1000,
  • "usable": true
}

Сняться с игры

Если пользователь - капитан, то снимается вся команда. Если игрок - он выходит из состава.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Убрать слот игрока

Удаляет свободный слот в команде.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Схема игры

Схема игры

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "transitions": [
    ],
  • "messages": [
    ],
  • "times": [
    ],
  • "access": { }
}

Процесс игры

Процесс игры

Выполнить действие

Выполнение действий в тестируемом квесте.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
One of
action
required
string
Value: "LevelClose"
teams
required
Array of integers or null <int32> (Id-rw) [ 1 .. 1000 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID команд.

object

Responses

Request samples

Content type
application/json
{
  • "action": "InfoblockOpen",
  • "teams": [
    ],
  • "args": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Ручной старт игры капитаном

Ручной старт игры капитаном при командном старте

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
team_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

Responses

Request samples

Content type
application/json
{
  • "team_id": 2147483647
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Схема игры

Схема игры

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "last_player_code": {
    },
  • "is_finished": true,
  • "is_feedback_provided": false,
  • "team_id": 2147483647,
  • "messages": [
    ],
  • "cached_at": 2147483647,
  • "cache_age": 2147483647,
  • "stat": "VISIBLE",
  • "flashes": [
    ],
  • "log_id": 2147483647,
  • "access": { },
  • "saved_at": {
    }
}

Статистика игры

Статистика игры

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "team_id": 2147483647,
  • "stat": [
    ],
  • "top": [
    ],
  • "access": { },
  • "saved_at": {
    }
}

Отправить код

Отправить код

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Request Body schema: application/json
required

Код

code
required
string [ 1 .. 512 ] characters [\p{Print}]+

Код уровня или инфоблока

scanned
boolean or null
Default: false

Код получен через сканер.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "scanned": false
}

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "last_player_code": {
    },
  • "is_finished": true,
  • "is_feedback_provided": false,
  • "team_id": 2147483647,
  • "messages": [
    ],
  • "cached_at": 2147483647,
  • "cache_age": 2147483647,
  • "stat": "VISIBLE",
  • "flashes": [
    ],
  • "log_id": 2147483647,
  • "access": { },
  • "saved_at": {
    }
}

Зафиксировать факт скриншота

Залогировать скриншот

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Оценить игру

Отправить оценки игры и отзыв на игру

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required

Код

required
Array of objects (GameMetric) = 3 items

Оценки квеста. Набор оценок зависит от транспорта.

feedback
string or null [ 0 .. 4096 ] characters [\p{Print}]*

Отзыв в свободной форме.

object or null (Id_Nickname)
object (Team)

Команда

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "feedback": "string",
  • "user": {
    },
  • "team": {
    }
}

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "last_player_code": {
    },
  • "is_finished": true,
  • "is_feedback_provided": false,
  • "team_id": 2147483647,
  • "messages": [
    ],
  • "cached_at": 2147483647,
  • "cache_age": 2147483647,
  • "stat": "VISIBLE",
  • "flashes": [
    ],
  • "log_id": 2147483647,
  • "access": { },
  • "saved_at": {
    }
}

Зафиксировать факт копирования

Залогировать копирование

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Загрузка фото в инфоблок

Загрузка фото в инфоблок

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Request Body schema: multipart/form-data
string <binary> [ 0 .. 16777216 ] characters

Фото

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Свободный ответ блока

Загрузка свободного ответа в инфоблок

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Request Body schema: application/json
answer
required
string [ 0 .. 65535 ] characters [\p{Print}]*

Свободный ответ.

Responses

Request samples

Content type
application/json
{
  • "answer": "string"
}

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Открыть инфоблок по кнопке

Открыть инфоблок по кнопке

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Responses

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "last_player_code": {
    },
  • "is_finished": true,
  • "is_feedback_provided": false,
  • "team_id": 2147483647,
  • "messages": [
    ],
  • "cached_at": 2147483647,
  • "cache_age": 2147483647,
  • "stat": "VISIBLE",
  • "flashes": [
    ],
  • "log_id": 2147483647,
  • "access": { },
  • "saved_at": {
    }
}

Нажата кнопка в тексте блока

Нажата кнопка в тексте блока

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Request Body schema: application/json
alias
required
string (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

text
string or null <= 1024 characters [\\p{Print}]*

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "last_player_code": {
    },
  • "is_finished": true,
  • "is_feedback_provided": false,
  • "team_id": 2147483647,
  • "messages": [
    ],
  • "cached_at": 2147483647,
  • "cache_age": 2147483647,
  • "stat": "VISIBLE",
  • "flashes": [
    ],
  • "log_id": 2147483647,
  • "access": { },
  • "saved_at": {
    }
}

Лог ввода кодов

SEARCHABLE Лог ввода кодов для команды игрока

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

is_own
boolean

Только свои

is_success
boolean

Только успешные

log_id
integer <int32> [ 1 .. 2147483647 ]

Выбирать события, связанные с log_id

Responses

Response samples

Content type
application/json
{
  • "log": [
    ],
  • "records": 2147483647
}

Управление играми

Управление играми

Game

id
required
integer <int32> (Id) [ 0 .. 2147483647 ]

Id

city_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

object or null (City)

Город

name
required
string [ 3 .. 180 ] characters [\p{Print}]*

Название игры

schema
string
Default: "LINEAR"
Enum: "LINEAR" "RANDOM" "ALL" "CUSTOM"

Схема выдачи заданий.

LINEAR
Уровни следуют один за другим. В каждый момент времени открыт только один, текущий уровень.

RANDOM
Уровни выдаются случайно для каждой команды. По возможности выдаётся уровень, на котором нет команд или который потенциально скоро освободится. В каждый момент времени открыт только один, текущий уровень.

ALL
Открываются сразу все игровые уровни.

CUSTOM
Схема игры настраивается автором вручную.

start
required
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

enroll_until
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

description
string or null [ 0 .. 32768 ] characters [\p{Print}]*

Описание игры

social_text
string or null [ 0 .. 16384 ] characters [\p{Print}]*

Текст для соцсетей

timing
string or null [ 0 .. 64 ] characters [\p{Print}]*

Ожидаемое время прохождения.

timing_for
string or null [ 0 .. 64 ] characters [\p{Print}]*

На кого рассчитано ожидаемое время прохождения

mileage
integer or null <int32> [ 0 .. 40075 ]

Минимальный пробег на игре в километрах.

max_players
required
integer <int32> [ 1 .. 100 ]

Максимальное количество игроков в команде.

cost
required
number <float> [ 0 .. 1000000 ]

Стоимость участия в рублях.

cost_qq
number or null <float> [ 0 .. 1000000 ]

Сумма, которая будет оплачена кукухами.

cost_loyalty
number or null <float> [ 0 .. 1000000 ]
Deprecated

Стоимость с учетом оплаты кукухами.

cost_discounted
number or null <float> [ 0 .. 1000000 ]

Стоимость со скидкой за раннюю регистрацию

cost_discounted_end
string or null <date-time> (DateTimeTZ-RO) <= 34 characters

Дата и время, с таймзоной, только чтение

tags
required
Array of strings (GameTag) [ 1 .. 7 ] items unique
Items Enum: "PHOTO" "BRAIN" "COMBAT" "SNOOP" "TOUR" "MAZE" "STREET" "URBAN"

Типы игры

transport
required
string (GameTransport)
Enum: "NONE" "ANY" "CAR" "FOOT" "BIKE"

Средство передвижения

created
required
string or null <date-time> (DateTimeTZ-RO) <= 34 characters

Дата и время, с таймзоной, только чтение

owner
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

Array of objects (GameAuthor) [ 0 .. 32 ] items unique
briefing_geo
string or null (GeoPoint) [ 5 .. 26 ] characters ^\((-?\d+\.\d+),(-?\d+\.\d+)\)$

Точка на карте

briefing_time
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

briefing_txt
string or null [ 0 .. 1024 ] characters [\p{Print}]*

Место предыгрового брифинга

published
boolean
Default: false

Игра доступна для поиска и регистрации.

score
number or null <float> [ 0 .. 5 ]

Средняя оценка.

uuid
string <uuid> = 36 characters ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

Уникальный идентификатор игры

splash
string or null <uri> [ 0 .. 2000 ] characters ^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[%\w...

Ссылка на картинку анонса

start_type
string
Default: "auto"
Enum: "manual" "auto" "team"

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

Array of objects or null (GameHint) [ 0 .. 32 ] items

Раздел подготовки к квесту.

testing
required
boolean
Default: false

Запущено тестирование автором.

running
required
boolean
Default: false

Игра запущена

start_in
required
integer <int32> [ 0 .. 2147483647 ]

Время в секундах, через которое стартует игра

enroll_closes_in
integer or null <int32> [ 0 .. 2147483647 ]

Время в секундах, через которое закрывается регистрация, если она ограничена.

object or null (Team)

Команда

object or null (GameFeedback)
Array of objects or null (Id_Nickname) [ 0 .. 1000 ] items unique

Состав команды

Array of objects or null (Team) [ 0 .. 1000 ] items

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

teams_count
integer <int32> [ 0 .. 1000000 ]

Количество команд, принявших участие.

teams_limit
integer or null <int32> [ 0 .. 1024 ]

Максимальное количество команд.

started_ago
required
integer <int32> [ 0 .. 2147483647 ]

Количество секунд, прошедших со старта квеста.

closed
boolean

Игра закрыта

closed_at
string or null <date-time> (DateTimeTZ-RO) <= 34 characters

Дата и время, с таймзоной, только чтение

Array of objects or null (GameMetricAvg) = 3 items

Итоговые оценки за квест по критериям.

stat
string (GameStatVisibility)
Enum: "VISIBLE" "OWN" "PASSED" "HIDDEN"

Видимость статистики

rank_type
string (GameRankType)
Enum: "TIME" "LEVELS" "GAME" "CUSTOM" "SCORE"

Метод расстановки мест.

rank_value
string (GameRankValue)
Enum: "TIME" "SCORE"

Игра на время или на баллы.

objectivity
number or null <float> [ 0 .. 1 ]

Доля поставивших оценку.

rank_var_1
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_1
string or null (GameRankSort)
Enum: "ASC" "DESC"
rank_var_2
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_2
string or null (GameRankSort)
Enum: "ASC" "DESC"
early_birds_global
boolean or null
Default: true

Применяются глобальные настройки скидок за раннюю регистрацию.

screenplay_public
boolean or null
Default: true

Просмотр сценария доступен игрокам после закрытия игры.

object or null (GameSocialMessagingData)

Данные для каналов оповещения. Доступно для автора.

object (RDBTimestamp)
charge_type
string (GameChargeType)
Enum: "TEAM" "PLAYER"

Оплата за участника или за команду.

franchise_id
integer or null <int32> (Id-nullable) [ 0 .. 2147483647 ]

Id-nullable

payment_methods
Array of strings or null (PaymentType) [ 0 .. 100 ] items
Enum: "sberbank" "tochka" "yoomoney" "cash"
object or null (BalanceLogItemOrder)

Данные заказа регистрации.

{
  • "id": 2147483647,
  • "city": {
    },
  • "name": "This Is The Game",
  • "schema": "LINEAR",
  • "start": "2019-08-24T14:15:22Z",
  • "enroll_until": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "social_text": "string",
  • "timing": "2-4 hours",
  • "timing_for": "Leaders",
  • "mileage": 50,
  • "max_players": 1,
  • "cost": 1500,
  • "cost_qq": 1000000,
  • "cost_loyalty": 1000000,
  • "cost_discounted": 1000000,
  • "cost_discounted_end": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "transport": "NONE",
  • "created": "2019-08-24T14:15:22Z",
  • "owner": 2147483647,
  • "authors": [
    ],
  • "briefing_geo": "(56.129129,40.408397)",
  • "briefing_time": "2019-08-24T14:15:22Z",
  • "briefing_txt": "string",
  • "published": false,
  • "score": 5,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "splash": "http://example.com",
  • "start_type": "manual",
  • "hints": [
    ],
  • "testing": false,
  • "running": false,
  • "start_in": 2147483647,
  • "enroll_closes_in": 2147483647,
  • "team": {
    },
  • "feedback": {
    },
  • "lineup": [
    ],
  • "teams": [
    ],
  • "teams_count": 1000000,
  • "teams_limit": 1024,
  • "started_ago": 2147483647,
  • "closed": true,
  • "closed_at": "2019-08-24T14:15:22Z",
  • "metrics": [
    ],
  • "stat": "VISIBLE",
  • "rank_type": "TIME",
  • "rank_value": "TIME",
  • "objectivity": 1,
  • "rank_var_1": 2147483647,
  • "rank_sort_1": "ASC",
  • "rank_var_2": 2147483647,
  • "rank_sort_2": "ASC",
  • "early_birds_global": true,
  • "screenplay_public": true,
  • "social_messaging": {
    },
  • "saved_at": {
    },
  • "charge_type": "TEAM",
  • "franchise_id": 2147483647,
  • "payment_methods": [
    ],
  • "order": {
    }
}

Создание игры

Создание игры

Authorizations:
password
Request Body schema: application/json
required
city_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

name
required
string [ 3 .. 180 ] characters [\p{Print}]*

Название игры

schema
string
Default: "LINEAR"
Enum: "LINEAR" "RANDOM" "ALL" "CUSTOM"

Схема выдачи заданий.

LINEAR
Уровни следуют один за другим. В каждый момент времени открыт только один, текущий уровень.

RANDOM
Уровни выдаются случайно для каждой команды. По возможности выдаётся уровень, на котором нет команд или который потенциально скоро освободится. В каждый момент времени открыт только один, текущий уровень.

ALL
Открываются сразу все игровые уровни.

CUSTOM
Схема игры настраивается автором вручную.

start
required
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

enroll_until
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

description
string or null [ 0 .. 32768 ] characters [\p{Print}]*

Описание игры

social_text
string or null [ 0 .. 16384 ] characters [\p{Print}]*

Текст для соцсетей

timing
string or null [ 0 .. 64 ] characters [\p{Print}]*

Ожидаемое время прохождения.

timing_for
string or null [ 0 .. 64 ] characters [\p{Print}]*

На кого рассчитано ожидаемое время прохождения

mileage
integer or null <int32> [ 0 .. 40075 ]

Минимальный пробег на игре в километрах.

max_players
required
integer <int32> [ 1 .. 100 ]

Максимальное количество игроков в команде.

cost
required
number <float> [ 0 .. 1000000 ]

Стоимость участия в рублях.

tags
required
Array of strings (GameTag) [ 1 .. 7 ] items unique
Items Enum: "PHOTO" "BRAIN" "COMBAT" "SNOOP" "TOUR" "MAZE" "STREET" "URBAN"

Типы игры

transport
required
string (GameTransport)
Enum: "NONE" "ANY" "CAR" "FOOT" "BIKE"

Средство передвижения

owner
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

briefing_geo
string or null (GeoPoint) [ 5 .. 26 ] characters ^\((-?\d+\.\d+),(-?\d+\.\d+)\)$

Точка на карте

briefing_time
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

briefing_txt
string or null [ 0 .. 1024 ] characters [\p{Print}]*

Место предыгрового брифинга

published
boolean
Default: false

Игра доступна для поиска и регистрации.

start_type
string
Default: "auto"
Enum: "manual" "auto" "team"

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

Array of objects or null (GameHint) [ 0 .. 32 ] items

Раздел подготовки к квесту.

teams_limit
integer or null <int32> [ 0 .. 1024 ]

Максимальное количество команд.

stat
string (GameStatVisibility)
Enum: "VISIBLE" "OWN" "PASSED" "HIDDEN"

Видимость статистики

rank_type
string (GameRankType)
Enum: "TIME" "LEVELS" "GAME" "CUSTOM" "SCORE"

Метод расстановки мест.

rank_value
string (GameRankValue)
Enum: "TIME" "SCORE"

Игра на время или на баллы.

rank_var_1
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_1
string or null (GameRankSort)
Enum: "ASC" "DESC"
rank_var_2
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_2
string or null (GameRankSort)
Enum: "ASC" "DESC"
early_birds_global
boolean or null
Default: true

Применяются глобальные настройки скидок за раннюю регистрацию.

screenplay_public
boolean or null
Default: true

Просмотр сценария доступен игрокам после закрытия игры.

object (RDBTimestamp)
charge_type
string (GameChargeType)
Enum: "TEAM" "PLAYER"

Оплата за участника или за команду.

franchise_id
integer or null <int32> (Id-nullable) [ 0 .. 2147483647 ]

Id-nullable

payment_methods
Array of strings or null (PaymentType) [ 0 .. 100 ] items
Enum: "sberbank" "tochka" "yoomoney" "cash"
object or null (BalanceLogItemOrder)

Данные заказа регистрации.

Responses

Request samples

Content type
application/json
{
  • "city_id": 2147483647,
  • "name": "This Is The Game",
  • "schema": "LINEAR",
  • "start": "2019-08-24T14:15:22Z",
  • "enroll_until": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "social_text": "string",
  • "timing": "2-4 hours",
  • "timing_for": "Leaders",
  • "mileage": 50,
  • "max_players": 1,
  • "cost": 1500,
  • "tags": [
    ],
  • "transport": "NONE",
  • "owner": 2147483647,
  • "briefing_geo": "(56.129129,40.408397)",
  • "briefing_time": "2019-08-24T14:15:22Z",
  • "briefing_txt": "string",
  • "published": false,
  • "start_type": "manual",
  • "hints": [
    ],
  • "team": {
    },
  • "feedback": {
    },
  • "teams_limit": 1024,
  • "stat": "VISIBLE",
  • "rank_type": "TIME",
  • "rank_value": "TIME",
  • "rank_var_1": 2147483647,
  • "rank_sort_1": "ASC",
  • "rank_var_2": 2147483647,
  • "rank_sort_2": "ASC",
  • "early_birds_global": true,
  • "screenplay_public": true,
  • "saved_at": {
    },
  • "charge_type": "TEAM",
  • "franchise_id": 2147483647,
  • "payment_methods": [
    ],
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "city": {
    },
  • "name": "This Is The Game",
  • "schema": "LINEAR",
  • "start": "2019-08-24T14:15:22Z",
  • "enroll_until": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "social_text": "string",
  • "timing": "2-4 hours",
  • "timing_for": "Leaders",
  • "mileage": 50,
  • "max_players": 1,
  • "cost": 1500,
  • "cost_qq": 1000000,
  • "cost_loyalty": 1000000,
  • "cost_discounted": 1000000,
  • "cost_discounted_end": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "transport": "NONE",
  • "created": "2019-08-24T14:15:22Z",
  • "owner": 2147483647,
  • "authors": [
    ],
  • "briefing_geo": "(56.129129,40.408397)",
  • "briefing_time": "2019-08-24T14:15:22Z",
  • "briefing_txt": "string",
  • "published": false,
  • "score": 5,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "splash": "http://example.com",
  • "start_type": "manual",
  • "hints": [
    ],
  • "testing": false,
  • "running": false,
  • "start_in": 2147483647,
  • "enroll_closes_in": 2147483647,
  • "team": {
    },
  • "feedback": {
    },
  • "lineup": [
    ],
  • "teams": [
    ],
  • "teams_count": 1000000,
  • "teams_limit": 1024,
  • "started_ago": 2147483647,
  • "closed": true,
  • "closed_at": "2019-08-24T14:15:22Z",
  • "metrics": [
    ],
  • "stat": "VISIBLE",
  • "rank_type": "TIME",
  • "rank_value": "TIME",
  • "objectivity": 1,
  • "rank_var_1": 2147483647,
  • "rank_sort_1": "ASC",
  • "rank_var_2": 2147483647,
  • "rank_sort_2": "ASC",
  • "early_birds_global": true,
  • "screenplay_public": true,
  • "social_messaging": {
    },
  • "saved_at": {
    },
  • "charge_type": "TEAM",
  • "franchise_id": 2147483647,
  • "payment_methods": [
    ],
  • "order": {
    }
}

Клонирование игры

Клонирование игры

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
to
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Если указано - клонируется только сценарий, без анонса.

Responses

Request samples

Content type
application/json
{
  • "to": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647
}

Редактирование игры

Обновление параметров игры

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
city_id
integer or null <int32> (Id-wo) [ 0 .. 2147483647 ]

Id

name
required
string [ 3 .. 180 ] characters [\p{Print}]*

Название игры

schema
string
Default: "LINEAR"
Enum: "LINEAR" "RANDOM" "ALL" "CUSTOM"

Схема выдачи заданий.

LINEAR
Уровни следуют один за другим. В каждый момент времени открыт только один, текущий уровень.

RANDOM
Уровни выдаются случайно для каждой команды. По возможности выдаётся уровень, на котором нет команд или который потенциально скоро освободится. В каждый момент времени открыт только один, текущий уровень.

ALL
Открываются сразу все игровые уровни.

CUSTOM
Схема игры настраивается автором вручную.

start
required
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

enroll_until
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

description
string or null [ 0 .. 32768 ] characters [\p{Print}]*

Описание игры

social_text
string or null [ 0 .. 16384 ] characters [\p{Print}]*

Текст для соцсетей

timing
string or null [ 0 .. 64 ] characters [\p{Print}]*

Ожидаемое время прохождения.

timing_for
string or null [ 0 .. 64 ] characters [\p{Print}]*

На кого рассчитано ожидаемое время прохождения

mileage
integer or null <int32> [ 0 .. 40075 ]

Минимальный пробег на игре в километрах.

max_players
required
integer <int32> [ 1 .. 100 ]

Максимальное количество игроков в команде.

cost
required
number <float> [ 0 .. 1000000 ]

Стоимость участия в рублях.

tags
required
Array of strings (GameTag) [ 1 .. 7 ] items unique
Items Enum: "PHOTO" "BRAIN" "COMBAT" "SNOOP" "TOUR" "MAZE" "STREET" "URBAN"

Типы игры

transport
required
string (GameTransport)
Enum: "NONE" "ANY" "CAR" "FOOT" "BIKE"

Средство передвижения

owner
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

briefing_geo
string or null (GeoPoint) [ 5 .. 26 ] characters ^\((-?\d+\.\d+),(-?\d+\.\d+)\)$

Точка на карте

briefing_time
string or null <date-time> (DateTimeTZ) <= 32 characters

Дата и время, с таймзоной

briefing_txt
string or null [ 0 .. 1024 ] characters [\p{Print}]*

Место предыгрового брифинга

published
boolean
Default: false

Игра доступна для поиска и регистрации.

start_type
string
Default: "auto"
Enum: "manual" "auto" "team"

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

Array of objects or null (GameHint) [ 0 .. 32 ] items

Раздел подготовки к квесту.

teams_limit
integer or null <int32> [ 0 .. 1024 ]

Максимальное количество команд.

stat
string (GameStatVisibility)
Enum: "VISIBLE" "OWN" "PASSED" "HIDDEN"

Видимость статистики

rank_type
string (GameRankType)
Enum: "TIME" "LEVELS" "GAME" "CUSTOM" "SCORE"

Метод расстановки мест.

rank_value
string (GameRankValue)
Enum: "TIME" "SCORE"

Игра на время или на баллы.

rank_var_1
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_1
string or null (GameRankSort)
Enum: "ASC" "DESC"
rank_var_2
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

rank_sort_2
string or null (GameRankSort)
Enum: "ASC" "DESC"
early_birds_global
boolean or null
Default: true

Применяются глобальные настройки скидок за раннюю регистрацию.

screenplay_public
boolean or null
Default: true

Просмотр сценария доступен игрокам после закрытия игры.

object (RDBTimestamp)
charge_type
string (GameChargeType)
Enum: "TEAM" "PLAYER"

Оплата за участника или за команду.

franchise_id
integer or null <int32> (Id-nullable) [ 0 .. 2147483647 ]

Id-nullable

payment_methods
Array of strings or null (PaymentType) [ 0 .. 100 ] items
Enum: "sberbank" "tochka" "yoomoney" "cash"
object or null (BalanceLogItemOrder)

Данные заказа регистрации.

Responses

Request samples

Content type
application/json
{
  • "city_id": 2147483647,
  • "name": "This Is The Game",
  • "schema": "LINEAR",
  • "start": "2019-08-24T14:15:22Z",
  • "enroll_until": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "social_text": "string",
  • "timing": "2-4 hours",
  • "timing_for": "Leaders",
  • "mileage": 50,
  • "max_players": 1,
  • "cost": 1500,
  • "tags": [
    ],
  • "transport": "NONE",
  • "owner": 2147483647,
  • "briefing_geo": "(56.129129,40.408397)",
  • "briefing_time": "2019-08-24T14:15:22Z",
  • "briefing_txt": "string",
  • "published": false,
  • "start_type": "manual",
  • "hints": [
    ],
  • "team": {
    },
  • "feedback": {
    },
  • "teams_limit": 1024,
  • "stat": "VISIBLE",
  • "rank_type": "TIME",
  • "rank_value": "TIME",
  • "rank_var_1": 2147483647,
  • "rank_sort_1": "ASC",
  • "rank_var_2": 2147483647,
  • "rank_sort_2": "ASC",
  • "early_birds_global": true,
  • "screenplay_public": true,
  • "saved_at": {
    },
  • "charge_type": "TEAM",
  • "franchise_id": 2147483647,
  • "payment_methods": [
    ],
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "city": {
    },
  • "name": "This Is The Game",
  • "schema": "LINEAR",
  • "start": "2019-08-24T14:15:22Z",
  • "enroll_until": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "social_text": "string",
  • "timing": "2-4 hours",
  • "timing_for": "Leaders",
  • "mileage": 50,
  • "max_players": 1,
  • "cost": 1500,
  • "cost_qq": 1000000,
  • "cost_loyalty": 1000000,
  • "cost_discounted": 1000000,
  • "cost_discounted_end": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "transport": "NONE",
  • "created": "2019-08-24T14:15:22Z",
  • "owner": 2147483647,
  • "authors": [
    ],
  • "briefing_geo": "(56.129129,40.408397)",
  • "briefing_time": "2019-08-24T14:15:22Z",
  • "briefing_txt": "string",
  • "published": false,
  • "score": 5,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "splash": "http://example.com",
  • "start_type": "manual",
  • "hints": [
    ],
  • "testing": false,
  • "running": false,
  • "start_in": 2147483647,
  • "enroll_closes_in": 2147483647,
  • "team": {
    },
  • "feedback": {
    },
  • "lineup": [
    ],
  • "teams": [
    ],
  • "teams_count": 1000000,
  • "teams_limit": 1024,
  • "started_ago": 2147483647,
  • "closed": true,
  • "closed_at": "2019-08-24T14:15:22Z",
  • "metrics": [
    ],
  • "stat": "VISIBLE",
  • "rank_type": "TIME",
  • "rank_value": "TIME",
  • "objectivity": 1,
  • "rank_var_1": 2147483647,
  • "rank_sort_1": "ASC",
  • "rank_var_2": 2147483647,
  • "rank_sort_2": "ASC",
  • "early_birds_global": true,
  • "screenplay_public": true,
  • "social_messaging": {
    },
  • "saved_at": {
    },
  • "charge_type": "TEAM",
  • "franchise_id": 2147483647,
  • "payment_methods": [
    ],
  • "order": {
    }
}

Настройки дашборда

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

key
required
string [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Responses

Response samples

Content type
application/json
{
  • "axis": "horizontal",
  • "flex": 1000,
  • "type": "empty",
  • "settings": {
    },
  • "controlData": {
    },
  • "areas": [
    ]
}

Сохранение дашборда

Сохранение дашборда

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

key
required
string [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$
Request Body schema: application/json
axis
string
Enum: "horizontal" "vertical"
flex
number <double> [ 0 .. 1000 ]
type
string or null
Enum: "empty" "infoBlock" "infoBlockSingleTeam" "globalTimer" "teamTimer" "top" "eventLog"
object or null
object or null
areas
Array of objects (DashboardArea) [ 0 .. 10 ] items

Responses

Request samples

Content type
application/json
{
  • "axis": "horizontal",
  • "flex": 1000,
  • "type": "empty",
  • "settings": {
    },
  • "controlData": {
    },
  • "areas": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Свои игры

SEARCHABLE Поиск своих игр

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "games": [
    ],
  • "records": 2147483647
}

Статистика игры

Статистика игры.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "stat": [
    ],
  • "top": [
    ],
  • "access": { },
  • "saved_at": {
    },
  • "timers": [
    ]
}

Список фото Deprecated

Список фото, загруженных командами

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "levels": [
    ]
}

(Не)одобрение фото Deprecated

(Не)одобрение фото, загруженных командами

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
block_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

level_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

team_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

accepted
required
boolean

Responses

Request samples

Content type
application/json
{
  • "block_id": 2147483647,
  • "level_id": 2147483647,
  • "team_id": 2147483647,
  • "accepted": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Список (фото)ответов

Список (фото)ответов, загруженных командами

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "levels": [
    ]
}

(Не)одобрение ответа

(Не)одобрение ответов, загруженных командами

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
block_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

level_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

team_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

accepted_terms
required
Array of integers or null <int32> (Id-rw) [ 0 .. 16 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

Responses

Request samples

Content type
application/json
{
  • "block_id": 2147483647,
  • "level_id": 2147483647,
  • "team_id": 2147483647,
  • "accepted_terms": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Выполнить действие

Выполнение действий в квесте.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
One of
action
required
string
Value: "LevelClose"
teams
required
Array of integers or null <int32> (Id-rw) [ 1 .. 1000 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID команд.

object

Responses

Request samples

Content type
application/json
{
  • "action": "LevelClose",
  • "teams": [
    ],
  • "args": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Погашение долга

Погашение авторского долга. Авторы, имеющие отрицательный баланс, который может возникнуть из-за приёма взносов наличными, не могут запускать игры до погашения долга. Игры с автоматическим стартом в указанное время переводятся в режим ручного старта.

Authorizations:
password
Request Body schema: application/json
pay_by
required
string (PaymentType)
Enum: "sberbank" "tochka" "yoomoney" "cash"

Responses

Request samples

Content type
application/json
{
  • "pay_by": "sberbank"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Загрузка картинки анонса

Загрузка картинки анонса

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: multipart/form-data
required

Картинка анонса

string <binary> [ 0 .. 16777216 ] characters

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Список файлов игры

Список файлов игры

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Загрузка файла к игре

Загрузка файла к игре

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: multipart/form-data
required

Произвольный файл к игре

string <binary> [ 0 .. 16777216 ] characters (\w|\W)*

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Удаление файла

Удаление файла к игре.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
filename
required
string [ 1 .. 2048 ] characters [\p{Print}]*

Имя файла для удаления.

Responses

Request samples

Content type
application/json
{
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Подготовить ссылку для загрузки

Подготовить ссылку для загрузки

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
Array of objects [ 0 .. 100 ] items

Responses

Request samples

Content type
application/json
{
  • "uploads": [
    ]
}

Response samples

Content type
application/json
{
  • "links": [
    ]
}

Ручной старт игры

Ручной старт игры автором

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Запустить тест

Старт тестирования автором.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
team_per_author
boolean
Default: false

Создавать каждому соавтору по отдельной команде.

Responses

Request samples

Content type
application/json
{
  • "team_per_author": false
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Остановить тест

Остановка теста автором

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Сделать вечной

Перевод игры в постоянные.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Закрытие игры

Закрывает игру, начисляет реферальные и вознаграждение автору. Действие не может быть отменено.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Лог ввода кодов

SEARCHABLE Мониторинг

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "log": [
    ],
  • "records": 2147483647
}

Текст для соцсети

Текст для соцсети

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
type
required
string
Enum: "vk" "tg" "ig" "push"

Тип соцсети

Responses

Response samples

Content type
application/json
{
  • "type": "vk",
  • "message": "string"
}

Отправить в соцсеть.

Разместить сообщение в соцсетях.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
type
required
string (SocialNetworkType)
Enum: "vk" "tg" "ig" "push"

Тип соцсети.

message
required
string [ 0 .. 16384 ] characters [\p{Print}]*

Сообщение.

Responses

Request samples

Content type
application/json
{
  • "type": "vk",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "status": "ENABLED",
  • "enabled_in": -2147483648
}

Автор: команды

SEARCHABLE Детальный список команд, участвующих в игре.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "teams": [
    ],
  • "records": 2147483647
}

Автор: соавторы

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

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
authors
required
Array of integers or null <int32> (Id-rw) [ 0 .. 32 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID соавторов.

Responses

Request samples

Content type
application/json
{
  • "authors": [
    ]
}

Response samples

Content type
application/json
{
  • "authors": [
    ]
}

Автор: сообщение игрокам

Новое сообщение игрокам.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
levels
Array of integers or null <int32> (Id-rw) [ 0 .. 100 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID уровней, на которых показывать сообщение.

teams
Array of integers or null <int32> (Id-rw) [ 0 .. 10000 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID команд, которым показывать сообщение.

message
string [ 0 .. 2048 ] characters [\p{Print}]*

Responses

Request samples

Content type
application/json
{
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string"
}

Редактирование сообщения

Редактирование сообщения игрокам.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

message_id
required
integer <int32> [ 1 .. 2147483647 ]

ID сообщения

Request Body schema: application/json
levels
Array of integers or null <int32> (Id-rw) [ 0 .. 100 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID уровней, на которых показывать сообщение.

teams
Array of integers or null <int32> (Id-rw) [ 0 .. 10000 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID команд, которым показывать сообщение.

message
string [ 0 .. 2048 ] characters [\p{Print}]*

Responses

Request samples

Content type
application/json
{
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string"
}

Удаление сообщения

Удаление сообщения игрокам.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

message_id
required
integer <int32> [ 1 .. 2147483647 ]

ID сообщения

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Автор: корректировка времени

Новая корректировка времени.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
levels
Array of integers or null <int32> (Id-rw) [ 0 .. 100 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID уровней, на которых применяется корректировка.

teams
Array of integers or null <int32> (Id-rw) [ 0 .. 10000 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID команд, которым применять корректировку.

message
string or null [ 0 .. 2048 ] characters [\p{Print}]*
change_time
required
integer <int32> (DurationEpoch) [ -2147483648 .. 2147483647 ]
is_manual
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string",
  • "change_time": -2147483648,
  • "is_manual": false
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string",
  • "change_time": -2147483648,
  • "is_manual": false
}

Редактирование сообщения

Редактирование корректировки времени.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

time_id
required
integer <int32> [ 1 .. 2147483647 ]

ID корректировки времени

Request Body schema: application/json
levels
Array of integers or null <int32> (Id-rw) [ 0 .. 100 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID уровней, на которых применяется корректировка.

teams
Array of integers or null <int32> (Id-rw) [ 0 .. 10000 ] items [ items <int32 > [ 0 .. 2147483647 ] ]

ID команд, которым применять корректировку.

message
string or null [ 0 .. 2048 ] characters [\p{Print}]*
change_time
required
integer <int32> (DurationEpoch) [ -2147483648 .. 2147483647 ]
is_manual
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string",
  • "change_time": -2147483648,
  • "is_manual": false
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "levels": [
    ],
  • "teams": [
    ],
  • "message": "string",
  • "change_time": -2147483648,
  • "is_manual": false
}

Удаление корректировки времени

Удаление корректировки времени.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

time_id
required
integer <int32> [ 1 .. 2147483647 ]

ID корректировки времени

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Подготовка к квесту

Справочник раздела "подготовка к квесту"

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "hints": [
    ],
  • "records": 2147483647
}

Хинт по ID

Хинт по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "title": "string",
  • "icon": "string",
  • "description": "string"
}

Управление уровнями

Управление уровнями

Схема игры

Схема игры

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "transitions": [
    ],
  • "messages": [
    ],
  • "times": [
    ],
  • "access": { }
}

Генератор схемы Deprecated

Генерирует начальный шаблон игры. Параметры запроса зависят от типа генератора.

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

Параметры:

  level_count # количество игровых уровней
  level       # шаблон игрового уровня
  legend      # шаблон вступительного уровня (легенды)
  finish      # шаблон финального уровня
Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
type
required
string
level_count
required
integer <int32> [ 1 .. 100 ]
required
object (GameLevel)

Уровень игры

object (GameLevel)

Уровень игры

object (GameLevel)

Уровень игры

Responses

Request samples

Content type
application/json
{
  • "type": "LINEAR",
  • "level_count": 1,
  • "level": {
    },
  • "legend": {
    },
  • "finish": {
    }
}

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "environment": {
    },
  • "transitions": [
    ],
  • "messages": [
    ],
  • "times": [
    ],
  • "access": { }
}

Список уровней игры Deprecated

SEARCHABLE

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "levels": [
    ],
  • "records": 2147483647
}

Создание уровня Deprecated

Создание уровня

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

name
string or null [ 1 .. 64 ] characters [\p{Print}]*

Название уровня

Array of objects or null (Code) [ 0 .. 1024 ] items

Коды уровня

duration
string or null (Duration) <= 32 characters ^\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS)

Array of IBText (object) or IBPhoto (object) or IBPhotoCompare (object) or IBFreeAnswer (object) or IBGrid (object) or IBVars (object) or null (LevelInfoBlock) [ 1 .. 300 ] items

Текстовые блоки уровня

sort
integer or null <int32> [ -2147483648 .. 2147483647 ]

Порядок сортировки уровней.

autoclose_penalty_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
is_cut_off
boolean
Default: false

Уровень-заглушка. Время, проведённое на нём, не учитывается в статистике и итогах.

flow
string
Default: "LEVEL"
Enum: "LEGEND" "LEVEL" "FINAL"

Тип уровня для генератора переходов.

before_open
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
after_close
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
blocks_sort_by
string
Default: "SORT"
Enum: "SORT" "OPENED"

Сортировать блоки во время прохождения квеста по заданной автором сортировке или по мере открытия игроками.

object or null (ChartOffset)
code_name
string or null (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

Responses

Request samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "codes": [
    ],
  • "duration": "string",
  • "infoblocks": [
    ],
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "blocks_sort_by": "SORT",
  • "chart": {
    },
  • "code_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "codes": [
    ],
  • "duration": "string",
  • "infoblocks": [
    ],
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "blocks_sort_by": "SORT",
  • "chart": {
    },
  • "code_name": "string"
}

Изменение сортировки

Изменение сортировки уровней

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
Array ([ 0 .. 1000 ] items)
id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

sort
required
integer <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Сохранение уровня

Сохранение полной структуры уровня

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

name
string or null [ 1 .. 64 ] characters [\p{Print}]*

Название уровня

Array of objects or null (Code) [ 0 .. 1024 ] items

Коды уровня

duration
string or null (Duration) <= 32 characters ^\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS)

Array of IBText (object) or IBPhoto (object) or IBPhotoCompare (object) or IBFreeAnswer (object) or IBGrid (object) or IBVars (object) or null (LevelInfoBlock) [ 1 .. 300 ] items

Текстовые блоки уровня

sort
integer or null <int32> [ -2147483648 .. 2147483647 ]

Порядок сортировки уровней.

autoclose_penalty_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
is_cut_off
boolean
Default: false

Уровень-заглушка. Время, проведённое на нём, не учитывается в статистике и итогах.

flow
string
Default: "LEVEL"
Enum: "LEGEND" "LEVEL" "FINAL"

Тип уровня для генератора переходов.

before_open
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
after_close
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
blocks_sort_by
string
Default: "SORT"
Enum: "SORT" "OPENED"

Сортировать блоки во время прохождения квеста по заданной автором сортировке или по мере открытия игроками.

object or null (ChartOffset)
code_name
string or null (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

Responses

Request samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "codes": [
    ],
  • "duration": "string",
  • "infoblocks": [
    ],
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "blocks_sort_by": "SORT",
  • "chart": {
    },
  • "code_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "codes": [
    ],
  • "duration": "string",
  • "infoblocks": [
    ],
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "blocks_sort_by": "SORT",
  • "chart": {
    },
  • "code_name": "string"
}

Уровень по ID Deprecated

Уровень по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "codes": [
    ],
  • "duration": "string",
  • "infoblocks": [
    ],
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "blocks_sort_by": "SORT",
  • "chart": {
    },
  • "code_name": "string"
}

Редактирование уровня Deprecated

Редактирование уровня

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Request Body schema: application/json
required
name
string or null [ 1 .. 64 ] characters [\p{Print}]*

Название уровня

duration
string or null (Duration) <= 32 characters ^\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS)

sort
integer or null <int32> [ -2147483648 .. 2147483647 ]

Порядок сортировки уровней.

autoclose_penalty_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
is_cut_off
boolean
Default: false

Уровень-заглушка. Время, проведённое на нём, не учитывается в статистике и итогах.

flow
string
Default: "LEVEL"
Enum: "LEGEND" "LEVEL" "FINAL"

Тип уровня для генератора переходов.

before_open
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
after_close
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "duration": "string",
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "codes": [
    ],
  • "duration": "string",
  • "infoblocks": [
    ],
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "blocks_sort_by": "SORT",
  • "chart": {
    },
  • "code_name": "string"
}

Удаление уровня

Удаление уровня

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Клонирование уровня

Клонирование уровня

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "codes": [
    ],
  • "duration": "string",
  • "infoblocks": [
    ],
  • "sort": -2147483648,
  • "autoclose_penalty_time": "string",
  • "is_cut_off": false,
  • "flow": "LEGEND",
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "blocks_sort_by": "SORT",
  • "chart": {
    },
  • "code_name": "string"
}

Инфоблоки уровня Deprecated

SEARCHABLE

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "infoblocks": [
    ],
  • "records": 2147483647
}

Создание инфоблока Deprecated

Создание инфоблока

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Request Body schema: application/json
required
One of
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

name
string or null [ 1 .. 180 ] characters [\p{Print}]*

Название блока

start
string or null <= 32 characters ^\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), через которое блок откроется

  • null - блок не откроется ни с уровнем, ни по таймеру
  • '00:00:00' - блок откроется с уровнем
  • '00:01:00' - блок откроется через указанное время
code
Array of strings or null or null (CodeVariant) [ 0 .. 16 ] items unique [ items [ 1 .. 512 ] characters [\p{Print}]* ]

Варианты кода, закрывающего текст блока

code_opening
Array of strings or null or null (CodeVariant) [ 0 .. 16 ] items unique [ items [ 1 .. 512 ] characters [\p{Print}]* ]

Варианты кода, открывающего текст блока

text_before
string or null [ 0 .. 65535 ] characters [\p{Print}]*

Текст блока

text
string or null [ 0 .. 65535 ] characters [\p{Print}]*

Текст блока

text_after
string or null [ 0 .. 65535 ] characters [\p{Print}]*

Текст блока

button
string or null [ 1 .. 32 ] characters [\p{Print}]*

Текст кнопки для открытия блока. Если задан - блок можно открыть по кнопке.

type
string or null [ 1 .. 32 ] characters [\p{Print}]*

Название группы/типа блоков.

button_early
boolean
Default: false

Кнопка открытия блока доступна до времени start

button_penalty_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
code_change_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
sort
integer or null <int32> [ -2147483648 .. 2147483647 ]

Порядок сортировки блоков.

before_open
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
after_close
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
code_name
string or null (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

layout
string (LevelInfoblockLayout)
Enum: "CLASSIC" "BORDERLESS"
logic
required
string
Value: "text"

Responses

Request samples

Content type
application/json
Example
{
  • "id": 2147483647,
  • "name": "string",
  • "start": "string",
  • "code": [
    ],
  • "code_opening": [
    ],
  • "text_before": "string",
  • "text": "string",
  • "text_after": "string",
  • "button": "string",
  • "type": "Bonuses",
  • "button_early": false,
  • "button_penalty_time": "string",
  • "code_change_time": "string",
  • "sort": -2147483648,
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "code_name": "string",
  • "layout": "CLASSIC",
  • "logic": "text"
}

Response samples

Content type
application/json
Example
{
  • "id": 2147483647,
  • "name": "string",
  • "start": "string",
  • "code": [
    ],
  • "code_opening": [
    ],
  • "text_before": "string",
  • "text": "string",
  • "text_after": "string",
  • "button": "string",
  • "type": "Bonuses",
  • "button_early": false,
  • "button_penalty_time": "string",
  • "code_change_time": "string",
  • "sort": -2147483648,
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "code_name": "string",
  • "layout": "CLASSIC",
  • "logic": "text"
}

Инфоблок по ID Deprecated

Инфоблок по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Responses

Response samples

Content type
application/json
Example
{
  • "id": 2147483647,
  • "name": "string",
  • "start": "string",
  • "code": [
    ],
  • "code_opening": [
    ],
  • "text_before": "string",
  • "text": "string",
  • "text_after": "string",
  • "button": "string",
  • "type": "Bonuses",
  • "button_early": false,
  • "button_penalty_time": "string",
  • "code_change_time": "string",
  • "sort": -2147483648,
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "code_name": "string",
  • "layout": "CLASSIC",
  • "logic": "text"
}

Редактирование инфоблока Deprecated

Редактирование инфоблока

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Request Body schema: application/json
required
One of
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

name
string or null [ 1 .. 180 ] characters [\p{Print}]*

Название блока

start
string or null <= 32 characters ^\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), через которое блок откроется

  • null - блок не откроется ни с уровнем, ни по таймеру
  • '00:00:00' - блок откроется с уровнем
  • '00:01:00' - блок откроется через указанное время
code
Array of strings or null or null (CodeVariant) [ 0 .. 16 ] items unique [ items [ 1 .. 512 ] characters [\p{Print}]* ]

Варианты кода, закрывающего текст блока

code_opening
Array of strings or null or null (CodeVariant) [ 0 .. 16 ] items unique [ items [ 1 .. 512 ] characters [\p{Print}]* ]

Варианты кода, открывающего текст блока

text_before
string or null [ 0 .. 65535 ] characters [\p{Print}]*

Текст блока

text
string or null [ 0 .. 65535 ] characters [\p{Print}]*

Текст блока

text_after
string or null [ 0 .. 65535 ] characters [\p{Print}]*

Текст блока

button
string or null [ 1 .. 32 ] characters [\p{Print}]*

Текст кнопки для открытия блока. Если задан - блок можно открыть по кнопке.

type
string or null [ 1 .. 32 ] characters [\p{Print}]*

Название группы/типа блоков.

button_early
boolean
Default: false

Кнопка открытия блока доступна до времени start

button_penalty_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
code_change_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
sort
integer or null <int32> [ -2147483648 .. 2147483647 ]

Порядок сортировки блоков.

before_open
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
after_close
string (Visibility)
Enum: "VISIBLE" "HIDDEN" "CONTENT"
code_name
string or null (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

layout
string (LevelInfoblockLayout)
Enum: "CLASSIC" "BORDERLESS"
logic
required
string
Value: "text"

Responses

Request samples

Content type
application/json
Example
{
  • "id": 2147483647,
  • "name": "string",
  • "start": "string",
  • "code": [
    ],
  • "code_opening": [
    ],
  • "text_before": "string",
  • "text": "string",
  • "text_after": "string",
  • "button": "string",
  • "type": "Bonuses",
  • "button_early": false,
  • "button_penalty_time": "string",
  • "code_change_time": "string",
  • "sort": -2147483648,
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "code_name": "string",
  • "layout": "CLASSIC",
  • "logic": "text"
}

Response samples

Content type
application/json
Example
{
  • "id": 2147483647,
  • "name": "string",
  • "start": "string",
  • "code": [
    ],
  • "code_opening": [
    ],
  • "text_before": "string",
  • "text": "string",
  • "text_after": "string",
  • "button": "string",
  • "type": "Bonuses",
  • "button_early": false,
  • "button_penalty_time": "string",
  • "code_change_time": "string",
  • "sort": -2147483648,
  • "before_open": "VISIBLE",
  • "after_close": "VISIBLE",
  • "code_name": "string",
  • "layout": "CLASSIC",
  • "logic": "text"
}

Удаление инфоблока Deprecated

Удаление инфоблока

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

block_id
required
integer <int32> [ 1 .. 2147483647 ]

ID инфоблока

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Управление кодами

Управление кодами

Список кодов уровня Deprecated

SEARCHABLE Список кодов уровня

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Responses

Response samples

Content type
application/json
{
  • "codes": [
    ],
  • "records": 2147483647
}

Добавить код Deprecated

Добавить код

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Request Body schema: application/json
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

name
string or null [ 1 .. 128 ] characters [\p{Print}]*
code
required
Array of strings or null (CodeVariant) [ 0 .. 16 ] items unique [ items [ 1 .. 512 ] characters [\p{Print}]* ]

Варианты кода

change_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
is_regex
boolean
Default: false

Код - RegExp. Используется регистронезависимое сравнение ~* на уровне SQL.

code_name
string or null (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

sort
integer or null <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "code": [
    ],
  • "change_time": "string",
  • "is_regex": false,
  • "code_name": "string",
  • "sort": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "code": [
    ],
  • "change_time": "string",
  • "team": {
    },
  • "is_regex": false,
  • "code_name": "string",
  • "sort": -2147483648
}

Код по ID Deprecated

Код по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

code_id
required
integer <int32> [ 1 .. 2147483647 ]

ID кода

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "code": [
    ],
  • "change_time": "string",
  • "team": {
    },
  • "is_regex": false,
  • "code_name": "string",
  • "sort": -2147483648
}

Изменение кода Deprecated

Изменение кода

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

code_id
required
integer <int32> [ 1 .. 2147483647 ]

ID кода

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Request Body schema: application/json
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

name
string or null [ 1 .. 128 ] characters [\p{Print}]*
code
required
Array of strings or null (CodeVariant) [ 0 .. 16 ] items unique [ items [ 1 .. 512 ] characters [\p{Print}]* ]

Варианты кода

change_time
string or null (DurationRelaxed) <= 33 characters ^-?\d+:[0-5]\d:[0-5]\d$

Время (HH:MM:SS), положительное или отрицательное.

  • Положительное время - штраф
  • Отрицательное время - бонус
is_regex
boolean
Default: false

Код - RegExp. Используется регистронезависимое сравнение ~* на уровне SQL.

code_name
string or null (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

sort
integer or null <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "code": [
    ],
  • "change_time": "string",
  • "is_regex": false,
  • "code_name": "string",
  • "sort": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "code": [
    ],
  • "change_time": "string",
  • "team": {
    },
  • "is_regex": false,
  • "code_name": "string",
  • "sort": -2147483648
}

Удалить код Deprecated

Удалить код

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

code_id
required
integer <int32> [ 1 .. 2147483647 ]

ID кода

level_id
required
integer <int32> [ 1 .. 2147483647 ]

ID уровня

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Управление переходами

Управление переходами

Обновление координат

Обновление координат на карте схемы

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
type
required
string
Enum: "level" "transition" "start" "finish" "enrollment" "unenrollment" "script"
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

required
object or null (ChartOffset)

Responses

Request samples

Content type
application/json
{
  • "type": "level",
  • "id": 2147483647,
  • "offset": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Список переходов игры

SEARCHABLE

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "transitions": [
    ],
  • "records": 2147483647
}

Создание перехода

Создание перехода

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
event
required
string (GameEvent)
Enum: "Start" "Finish" "LevelOpen" "LevelClose" "LevelCloseByTeam" "LevelVarChange" "EnvVarChange" "CodePass" "LevelTimeout" "InfoblockOpen" "InfoblockClose" "InfoblockCodePass" "InfoblockAnswerSet" "InfoblockPhotoUpload" "InfoblockSetFreeAnswer" "InfoblockAnswerApprove" "InfoblockFreeButtonPressed" "TeamEnrolled" "TeamUnenrolled" "TimerUp" "TimerPaused"

Тип события

required
GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) (GameCondition)
required
null or GameActionLevelOpen (object) or GameActionInfoblockOpen (object) or GameActionInfoblockFreeButtonPressed (object) or GameActionLevelClose (object) or GameActionInfoblockClose (object) or GameActionInfoblockSetVisibility (object) or GameActionEnvVarChange (object) or GameActionLevelVarChange (object) or GameActionFinish (object) or GameActionRunScript (object) or GameActionRunTimer (object) or GameActionPauseTimer (object) or GenerateTeamCodes (object) or RemoveTeamCodes (object) or GameActionChainCancel (object) (GameAction)
null or GameActionLevelOpen (object) or GameActionInfoblockOpen (object) or GameActionInfoblockFreeButtonPressed (object) or GameActionLevelClose (object) or GameActionInfoblockClose (object) or GameActionInfoblockSetVisibility (object) or GameActionEnvVarChange (object) or GameActionLevelVarChange (object) or GameActionFinish (object) or GameActionRunScript (object) or GameActionRunTimer (object) or GameActionPauseTimer (object) or GenerateTeamCodes (object) or RemoveTeamCodes (object) or GameActionChainCancel (object) (GameAction)
object or null (ChartOffset)

Responses

Request samples

Content type
application/json
{
  • "event": "Start",
  • "condition": {
    },
  • "action": { },
  • "action_else": { },
  • "chart": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "event": "Start",
  • "condition": {
    },
  • "action": { },
  • "action_else": { },
  • "chart": {
    }
}

Переход по ID

Переход по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

transition_id
required
integer <int32> [ 1 .. 2147483647 ]

ID перехода

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "event": "Start",
  • "condition": {
    },
  • "action": { },
  • "action_else": { },
  • "chart": {
    }
}

Редактирование перехода

Редактирование перехода

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

transition_id
required
integer <int32> [ 1 .. 2147483647 ]

ID перехода

Request Body schema: application/json
required
event
required
string (GameEvent)
Enum: "Start" "Finish" "LevelOpen" "LevelClose" "LevelCloseByTeam" "LevelVarChange" "EnvVarChange" "CodePass" "LevelTimeout" "InfoblockOpen" "InfoblockClose" "InfoblockCodePass" "InfoblockAnswerSet" "InfoblockPhotoUpload" "InfoblockSetFreeAnswer" "InfoblockAnswerApprove" "InfoblockFreeButtonPressed" "TeamEnrolled" "TeamUnenrolled" "TimerUp" "TimerPaused"

Тип события

required
GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) or GameCondition (object) (GameCondition)
required
null or GameActionLevelOpen (object) or GameActionInfoblockOpen (object) or GameActionInfoblockFreeButtonPressed (object) or GameActionLevelClose (object) or GameActionInfoblockClose (object) or GameActionInfoblockSetVisibility (object) or GameActionEnvVarChange (object) or GameActionLevelVarChange (object) or GameActionFinish (object) or GameActionRunScript (object) or GameActionRunTimer (object) or GameActionPauseTimer (object) or GenerateTeamCodes (object) or RemoveTeamCodes (object) or GameActionChainCancel (object) (GameAction)
null or GameActionLevelOpen (object) or GameActionInfoblockOpen (object) or GameActionInfoblockFreeButtonPressed (object) or GameActionLevelClose (object) or GameActionInfoblockClose (object) or GameActionInfoblockSetVisibility (object) or GameActionEnvVarChange (object) or GameActionLevelVarChange (object) or GameActionFinish (object) or GameActionRunScript (object) or GameActionRunTimer (object) or GameActionPauseTimer (object) or GenerateTeamCodes (object) or RemoveTeamCodes (object) or GameActionChainCancel (object) (GameAction)
object or null (ChartOffset)

Responses

Request samples

Content type
application/json
{
  • "event": "Start",
  • "condition": {
    },
  • "action": { },
  • "action_else": { },
  • "chart": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "event": "Start",
  • "condition": {
    },
  • "action": { },
  • "action_else": { },
  • "chart": {
    }
}

Удаление перехода

Удаление перехода

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

transition_id
required
integer <int32> [ 1 .. 2147483647 ]

ID перехода

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Управление переменными

Управление переменными

Список переменных игры

SEARCHABLE

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "variables": [
    ],
  • "records": 2147483647
}

Создание переменной

Создание переменной

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
name
required
string (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

scope
required
string (GameVariableScope)
Enum: "TEAM" "GAME"

Видимость переменной

type
string (GameVariableType)
Enum: "string" "number" "scale"

Тип переменной

initial
integer or number or string or boolean or null (GameVariableValue)
Deprecated

Начальное значение

color_id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]
Deprecated

Id

title
string or null [ 0 .. 32 ] characters [\p{Print}]*
Deprecated
details
string or null [ 0 .. 512 ] characters [\p{Print}]*
Deprecated

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scope": "TEAM",
  • "type": "string",
  • "initial": 0,
  • "color_id": 2147483647,
  • "title": "string",
  • "details": "string"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "scope": "TEAM",
  • "type": "string",
  • "initial": 0,
  • "color_id": 2147483647,
  • "title": "string",
  • "details": "string"
}

Переменная по ID

Переменная по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

variable_id
required
integer <int32> [ 1 .. 2147483647 ]

ID переменной

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "scope": "TEAM",
  • "type": "string",
  • "initial": 0,
  • "color_id": 2147483647,
  • "title": "string",
  • "details": "string"
}

Редактирование переменной

Редактирование переменной

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

variable_id
required
integer <int32> [ 1 .. 2147483647 ]

ID переменной

Request Body schema: application/json
required
name
required
string (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

scope
required
string (GameVariableScope)
Enum: "TEAM" "GAME"

Видимость переменной

type
string (GameVariableType)
Enum: "string" "number" "scale"

Тип переменной

initial
integer or number or string or boolean or null (GameVariableValue)
Deprecated

Начальное значение

color_id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]
Deprecated

Id

title
string or null [ 0 .. 32 ] characters [\p{Print}]*
Deprecated
details
string or null [ 0 .. 512 ] characters [\p{Print}]*
Deprecated

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scope": "TEAM",
  • "type": "string",
  • "initial": 0,
  • "color_id": 2147483647,
  • "title": "string",
  • "details": "string"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "scope": "TEAM",
  • "type": "string",
  • "initial": 0,
  • "color_id": 2147483647,
  • "title": "string",
  • "details": "string"
}

Удаление переменной

Удаление переменной

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

variable_id
required
integer <int32> [ 1 .. 2147483647 ]

ID переменной

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Управление таймерами

Управление таймерами

Список таймеров игры

SEARCHABLE

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "timers": [
    ],
  • "records": 2147483647
}

Создание таймера

Создание таймера

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
name
required
string (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название таймера

scope
required
string (GameVariableScope)
Enum: "TEAM" "GAME"

Видимость переменной

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scope": "TEAM"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "scope": "TEAM"
}

Таймер по ID

Таймер по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

timer_id
required
integer <int32> [ 1 .. 2147483647 ]

ID таймера

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "scope": "TEAM"
}

Редактирование таймера

Редактирование таймера

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

timer_id
required
integer <int32> [ 1 .. 2147483647 ]

ID таймера

Request Body schema: application/json
required
name
required
string (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название таймера

scope
required
string (GameVariableScope)
Enum: "TEAM" "GAME"

Видимость переменной

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scope": "TEAM"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "scope": "TEAM"
}

Удаление таймера

Удаление таймера

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

timer_id
required
integer <int32> [ 1 .. 2147483647 ]

ID таймера

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Управление командами

Управление командами

Отметка команды

Отметка команды. Устанавливает флаг checked в списке команд в true.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

team_id
required
integer <int32> [ 1 .. 2147483647 ]

ID команды

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Отметка команды

Отметка команды. Устанавливает флаг checked в списке команд в false.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

team_id
required
integer <int32> [ 1 .. 2147483647 ]

ID команды

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Снятие команды

Отмена регистрации команды. Взнос возвращается оплатившему регистрацию.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

team_id
required
integer <int32> [ 1 .. 2147483647 ]

ID команды

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Пользователи

Пользователи

Поиск пользователей

SEARCHABLE Поиск пользователей

Authorizations:
password
query Parameters
page
integer <int32> [ 1 .. 10000 ]
Default: 1

Страница

records
integer <int32> [ 1 .. 1000 ]
Default: 1000

Записей на странице

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "records": 2147483647
}

Обновление пользователя

Обновление пользователя. Обновляются только переданные поля.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
required
roles
Array of strings (Role) [ 1 .. 4 ] items unique
Items Enum: "AUTHOR" "PLAYER" "SUPPORT" "ADMIN" "KID"

Уровни доступа

avatar
null or null
active
boolean

Пользователь может авторизоваться.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "avatar": null,
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "phone": "79123456789",
  • "nickname": "crux",
  • "created": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "balance": -1000000,
  • "phone_code": 1000,
  • "refcode": "string",
  • "referrer": {
    },
  • "avatar": "http://example.com",
  • "activity": {
    },
  • "city": {
    },
  • "notify": false,
  • "delete_me": "2019-08-24T14:15:22Z",
  • "stat": {
    },
  • "active": true,
  • "vk_profile": {
    },
  • "has_password": false,
  • "settings": {
    },
  • "rdb_token": "string"
}

Финансы

Финансы

Вывод: смена статуса

Изменение статуса заявки на вывод.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
status
required
string or null (OrderWithdrawStatus)
Enum: "NEW" "PAYED" "HOLDED"

Статус заявки на вывод.

Responses

Request samples

Content type
application/json
{
  • "status": "NEW"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "user": {
    },
  • "amount": 1,
  • "status": "NEW",
  • "created": "2019-08-24T14:15:22Z"
}

Заявки на вывод

SEARCHABLE Список заявок на вывод.

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "records": 2147483647
}

Создать заявку на вывод

Создаёт запрос на вывод средств.

Authorizations:
password
Request Body schema: application/json

Параметры вывода.

amount
required
number <float> [ 1000 .. 1000000 ]

Сумма вывода.

user_id
required
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

Responses

Request samples

Content type
application/json
{
  • "amount": 1000,
  • "user_id": 2147483647
}

Response samples

Content type
application/json
{ }

Сводка

Финансовая сводка.

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "account_balance": 0.1,
  • "account_income": 0.1,
  • "account_withdrawals": 0.1,
  • "account_expected_income": 0.1,
  • "incoming_payment_full": 0.1,
  • "incoming_payment": 0.1,
  • "refunded": 0.1,
  • "aquirer_tax": 0.1,
  • "qq_balance": 0.1,
  • "qq_service_balance": 0.1,
  • "qq_users_balance": 0.1,
  • "qq_debt": 0.1,
  • "qq_withdraw": 0.1,
  • "qq_withdraw_waiting": 0.1,
  • "qq_divergence": 0.1,
  • "service_income_referral": 0.1,
  • "service_income_game": 0.1,
  • "service_income_game_ref_rest": 0.1,
  • "service_income_game_author_rest": 0.1,
  • "service_income_enrollment": 0.1,
  • "service_income_withdraw": 0.1,
  • "account_spendable": 0.1,
  • "unclosed_games_fee": 0.1,
  • "updated_at": "2019-08-24T14:15:22Z"
}

Справочники

Справочники

Добавить хинт

Добавить хинт в справочник

Authorizations:
password
Request Body schema: application/json
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

title
required
string [ 1 .. 64 ] characters [\p{Print}]*

Название.

icon
required
string [ 1 .. 128 ] characters [a-z_]+
description
required
string [ 1 .. 1024 ] characters [\p{Print}]*

Детальное описание для подробной подсказки.

Responses

Request samples

Content type
application/json
{
  • "id": 2147483647,
  • "title": "string",
  • "icon": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{ }

Редактирование хинта

Редактирование хинта

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

title
required
string [ 1 .. 64 ] characters [\p{Print}]*

Название.

icon
required
string [ 1 .. 128 ] characters [a-z_]+
description
required
string [ 1 .. 1024 ] characters [\p{Print}]*

Детальное описание для подробной подсказки.

Responses

Request samples

Content type
application/json
{
  • "id": 2147483647,
  • "title": "string",
  • "icon": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "title": "string",
  • "icon": "string",
  • "description": "string"
}

Удаление хинта

Удаление хинта

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Франшизы

Франшизы

Франшизы

Справочник внутренних франшиз

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "franchises": [
    ],
  • "records": 2147483647
}

Добавить франшизу

Добавить внутреннюю франшизу

Authorizations:
password
Request Body schema: application/json
alias
required
string (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

name
required
string (Printable) [ 0 .. 128 ] characters [\p{Print}]*
object

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "name": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{ }

Франшиза по ID

Франшиза по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "alias": "string",
  • "name": "string",
  • "settings": {
    }
}

Редактирование франшизы

Редактирование франшизы

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
alias
required
string (GameVariableName) [ 1 .. 64 ] characters ^[-A-Za-z0-9_]+$

Название переменной

name
required
string (Printable) [ 0 .. 128 ] characters [\p{Print}]*
object

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "name": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "alias": "string",
  • "name": "string",
  • "settings": {
    }
}

Удаление франшизы

Удаление франшизы

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Промокоды

Промокоды

Список промокодов

Список промокодов

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "promocodes": [
    ],
  • "records": 2147483647
}

Добавить промокод

Добавить промокод

Authorizations:
password
Request Body schema: application/json
One of
logic
string
Value: "simple"
code
required
string or null (Promocode) [ 1 .. 64 ] characters [A-Za-zА-Яа-яЁё0-9-.]+

Промокод

link
required
string
Enum: "player" "team" "public"

Тип привязки промокода к учётной записи. player - использовать может только привязавший игрок team - только капитан команды public - могут использовать разные игроки, но лимитировано количество применений на одного игрока

factor
number or null <float> [ 0 .. 1 ]

Коэффициент скидки.

fixed
number or null <float> [ 0 .. 1000000 ]

Фиксированная сумма.

limit_factor
number or null <float> [ 0 .. 1 ]

Максимальный коэффициент скидки.

from_date
string or null <date> <= 10 characters

Дата начала периода действия.

to_date
string or null <date> <= 10 characters

Дата окончания периода действия.

count
integer or null <int32> [ 1 .. 1000000 ]

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

team_id
integer or null <int32> (Id-nullable) [ 0 .. 2147483647 ]

Id-nullable

public_use
integer or null <int32> [ 1 .. 1000000 ]

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

details
string or null [ 0 .. 256 ] characters [\p{Print}]*
franchise_id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

Responses

Request samples

Content type
application/json
{
  • "logic": "regex",
  • "args": {
    },
  • "code": "NEWBIE",
  • "link": "player",
  • "factor": 1,
  • "fixed": 1000000,
  • "limit_factor": 1,
  • "from_date": "2019-08-24",
  • "to_date": "2019-08-24",
  • "count": 1,
  • "team_id": 2147483647,
  • "public_use": 1,
  • "details": "string",
  • "franchise_id": 2147483647
}

Response samples

Content type
application/json
{
  • "logic": "regex",
  • "args": {
    },
  • "id": 2147483647,
  • "code": "NEWBIE",
  • "link": "player",
  • "factor": 1,
  • "fixed": 1000000,
  • "limit_factor": 1,
  • "from_date": "2019-08-24",
  • "to_date": "2019-08-24",
  • "count": 1,
  • "team": "string",
  • "team_id": 2147483647,
  • "user": "crux",
  • "used": 1000000,
  • "public_use": 1,
  • "public_used": 1000000,
  • "expired": false,
  • "details": "string",
  • "franchise_id": 2147483647
}

Промокод по ID

Промокод по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "logic": "regex",
  • "args": {
    },
  • "id": 2147483647,
  • "code": "NEWBIE",
  • "link": "player",
  • "factor": 1,
  • "fixed": 1000000,
  • "limit_factor": 1,
  • "from_date": "2019-08-24",
  • "to_date": "2019-08-24",
  • "count": 1,
  • "team": "string",
  • "team_id": 2147483647,
  • "user": "crux",
  • "used": 1000000,
  • "public_use": 1,
  • "public_used": 1000000,
  • "expired": false,
  • "details": "string",
  • "franchise_id": 2147483647
}

Редактирование промокода

Редактирование промокода

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
One of
logic
string
Value: "simple"
code
required
string or null (Promocode) [ 1 .. 64 ] characters [A-Za-zА-Яа-яЁё0-9-.]+

Промокод

link
required
string
Enum: "player" "team" "public"

Тип привязки промокода к учётной записи. player - использовать может только привязавший игрок team - только капитан команды public - могут использовать разные игроки, но лимитировано количество применений на одного игрока

factor
number or null <float> [ 0 .. 1 ]

Коэффициент скидки.

fixed
number or null <float> [ 0 .. 1000000 ]

Фиксированная сумма.

limit_factor
number or null <float> [ 0 .. 1 ]

Максимальный коэффициент скидки.

from_date
string or null <date> <= 10 characters

Дата начала периода действия.

to_date
string or null <date> <= 10 characters

Дата окончания периода действия.

count
integer or null <int32> [ 1 .. 1000000 ]

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

team_id
integer or null <int32> (Id-nullable) [ 0 .. 2147483647 ]

Id-nullable

public_use
integer or null <int32> [ 1 .. 1000000 ]

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

details
string or null [ 0 .. 256 ] characters [\p{Print}]*
franchise_id
integer or null <int32> (Id-rw) [ 0 .. 2147483647 ]

Id

Responses

Request samples

Content type
application/json
{
  • "logic": "regex",
  • "args": {
    },
  • "code": "NEWBIE",
  • "link": "player",
  • "factor": 1,
  • "fixed": 1000000,
  • "limit_factor": 1,
  • "from_date": "2019-08-24",
  • "to_date": "2019-08-24",
  • "count": 1,
  • "team_id": 2147483647,
  • "public_use": 1,
  • "details": "string",
  • "franchise_id": 2147483647
}

Response samples

Content type
application/json
{
  • "logic": "regex",
  • "args": {
    },
  • "id": 2147483647,
  • "code": "NEWBIE",
  • "link": "player",
  • "factor": 1,
  • "fixed": 1000000,
  • "limit_factor": 1,
  • "from_date": "2019-08-24",
  • "to_date": "2019-08-24",
  • "count": 1,
  • "team": "string",
  • "team_id": 2147483647,
  • "user": "crux",
  • "used": 1000000,
  • "public_use": 1,
  • "public_used": 1000000,
  • "expired": false,
  • "details": "string",
  • "franchise_id": 2147483647
}

Удаление промокода

Удаление промокода. Удалять можно только неиспользованные промокоды.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Обновить данные BLoC

Обновить данные

Authorizations:
password
Request Body schema: application/json
type
string
Enum: "promocode" "running_schema" "user"

Тип оповещения.

Array of objects or (Id (integer or null))

Параметры обновления

Responses

Request samples

Content type
application/json
{
  • "type": "promocode",
  • "all": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}

Цвета

Цвета

Список цветов

Список цветов

Authorizations:
password

Responses

Response samples

Content type
application/json
{
  • "colors": [
    ],
  • "records": 2147483647
}

Добавить цвет

Добавить цвет

Authorizations:
password
Request Body schema: application/json
name
required
string [ 1 .. 64 ] characters [\p{Print}]*
dark
required
string (VariableColorValue) = 8 characters ^[a-fA-F0-9]{8}$
light
required
string (VariableColorValue) = 8 characters ^[a-fA-F0-9]{8}$

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "dark": "stringst",
  • "light": "stringst"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "dark": "stringst",
  • "light": "stringst"
}

Цвет по ID

Цвет по ID

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "dark": "stringst",
  • "light": "stringst"
}

Редактирование цвета

Редактирование цвета

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Request Body schema: application/json
name
required
string [ 1 .. 64 ] characters [\p{Print}]*
dark
required
string (VariableColorValue) = 8 characters ^[a-fA-F0-9]{8}$
light
required
string (VariableColorValue) = 8 characters ^[a-fA-F0-9]{8}$

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "dark": "stringst",
  • "light": "stringst"
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "dark": "stringst",
  • "light": "stringst"
}

Удаление цвета

Удаление цвета.

Authorizations:
password
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "status": 100
}