/auth/telegram

Метод используется для авторизации пользователя в приложении на базе Telegram Mini Apps.

Адрес метода

/auth/telegram

Тестовый пользователь

Для авторизации под тестовым пользователем, необходимо создать тестового пользователя в панели управления и использовать его "Ключ авторизации" как значение параметра data

Параметры

Параметр Обязательный Тип Описание
data ДА string Строка полученная из Telegram.WebApp.initData
bot_id НЕТ int Идентификатор бота, для которого необходимо авторизовать пользователя
ref_code НЕТ string Реферальный идентификатор пригласившего пользователя

Device context (необязательные)

Параметр Тип Описание
app_platform string Платформа приложения (например: web, telegram)
distribution string Канал дистрибуции
app_version string Версия приложения (например: 1.2.3)

Результат

Данный метод в результате выполнения возвращает токен пользователя и его профиль. Токен используется для авторизации запросов от имени пользователя - подробнее. 

{
    "response": {
        "token": "......",
        ...member
    }
}
Поле Тип Описание
token string Содержит строку с идентификатором сессии пользователя
...member * Объект пользователя

events

Если во время авторизации была применена миграция профиля или у игрока есть непросмотренные компенсации, ответ может содержать блок events.

{
    "response": {
        "token": "......",
        "...member": {}
    },
    "events": [
        {
            "type": "migration",
            "payload": {
                "id": "profile.1.0.0.gacha_synth_sphere_to_token",
                "from_version": "0.100.0",
                "to_version": "1.0.0",
                "result": {
                    "type": "conversion",
                    "spent": [
                        { "type": "synthSphere", "amount": 250 }
                    ]
                }
            }
        },
        {
            "type": "reward",
            "payload": {
                "reasonType": "migration",
                "reasonId": "profile.1.0.0.gacha_synth_sphere_to_token",
                "rewards": [
                    { "type": "token", "amount": 3 }
                ]
            }
        },
        {
            "type": "reward",
            "payload": {
                "reasonType": "compensation",
                "reasonId": 12,
                "content": "{\"title\":\"test\",\"ru\":\"Компенсация за ошибку\",\"en\":\"Bug compensation\"}",
                "rewards": [
                    { "type": "hard", "amount": 100 }
                ]
            }
        }
    ]
}