Вход в аккаунт через телеграмм бота
📡 Вход в аккаунт через тг бота#
Ручка#
ws /ws/v1/sign_in_with_telegram
Полный адрес в сети#
| Среда | URL |
|---|---|
| 🧪 Dev | ws://web-socket-gateway.devterra.ru/ws/v1/sign_in_with_telegram |
| 🚀 Prod | ws://web-socket-gateway.terraprod.ru/ws/v1/sign_in_with_telegram |
Входные данные для верификации#
| Поле | Тип | Описание | Обязательное | Пример |
|---|---|---|---|---|
| phone | string | Номер телефона пользователя | ❌ | +7 999 123-12-12 |
Номер телефона можно ввести в любом формате. Он будет провалидирован и отформатирован
Является необязательным полем, однако отправка телефона позволит проверить в нужный ли аккаунт входит пользователь
Пример JSON запроса#
Стандартная строка
{
"phone": "+7 999 123-45-67"
}
Base64 формат
{
"phone": "Nzk1MDEwNTk2NjI="
}
Выходные данные, которые будут в ответе#
| Поле | Тип | Описание | Обязательное | Пример |
|---|---|---|---|---|
| username | string | ТГ юзернейм пользователя | ❌ | @Bazar_lol |
| tgURL | string | Ссылка на тг бота для перехода | ❌ | https://t.me/terra_app_auth_bot?start=e3b19ca9-cab7-4387-a42e-3f5ad48326ab |
| apiKey | string | Ключ авторизации | ❌ | 47f44e56-2e4f-407e-8b07-115ea8783be7 |
| isPing | bool | Является ли данное сообщение пингом | ✅ | true |
Пример JSON ответов#
Первое сообщение отправляемое пользователю
{
"username": null,
"apiKey": null,
"tgURL": "https://t.me/working_12bot?start=7b4ae464-8353-4f3b-821b-f286ed6fb00f",
"isPing": false
}
Пока пользователь не верифицировал тг
Будет отправляться пользователю с периодичностью раз в 10 секунд
{
"username": null,
"apiKey": null,
"tgURL": "https://t.me/working_12bot?start=7b4ae464-8353-4f3b-821b-f286ed6fb00f",
"isPing": true
}
Когда пользователь верифицировал телеграм
{
"username": "@Seva5434",
"apiKey": "f9234d14-b46c-44a6-9a92-733af99b4b27",
"tgURL": null,
"isPing": false
}
В случае ошибки
{
"showError": true,
"message": "Пользователь не найден",
"statusCode": 404,
"traceID": "c8c30b0c531d50fa76544284bead568a",
"description": "AUTH_SERVICE.USER_NOT_FOUND"
}