Инструменты пользователя
auth
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
auth [2025/07/21 07:02] serg |
auth [2025/07/21 12:25] (текущий) serg |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| ====== Протокол API для аутентификации пользователей ====== | ====== Протокол API для аутентификации пользователей ====== | ||
| <code>Domain auth.kokids.org</code> | <code>Domain auth.kokids.org</code> | ||
| - | ===== 1. Создание пользователя ===== | + | ===== 1. Вход (Создание при отсутствии) пользователя ===== |
| <code> | <code> | ||
| - | Эндпоинт: /user/create?id=1&token=12345678901234567890123456789012 | + | Эндпоинт: /user/login?id=1&token=12345678901234567890123456789012 |
| Метод: POST | Метод: POST | ||
| Строка 14: | Строка 14: | ||
| OSInt (обязательный): Целочисленный идентификатор операционной системы. | OSInt (обязательный): Целочисленный идентификатор операционной системы. | ||
| GAID (обязательный): Идентификатор устройства Google. | GAID (обязательный): Идентификатор устройства Google. | ||
| + | Gaidtype (обязательный) | ||
| SDKVerC (необязательный): Версия SDK.</code> | SDKVerC (необязательный): Версия SDK.</code> | ||
| **Пример запроса (формат формы):** | **Пример запроса (формат формы):** | ||
| - | <code>AccID=randomID | + | <code> |
| Email=random000@gmail.com | Email=random000@gmail.com | ||
| UserID=random-firebase-user-id000 | UserID=random-firebase-user-id000 | ||
| Строка 33: | Строка 34: | ||
| "message": "User created successfully" | "message": "User created successfully" | ||
| }</code> | }</code> | ||
| + | <code>200 OK: Вход выполнен успешно. | ||
| + | { | ||
| + | "error": "", | ||
| + | "token": "exampleToken", | ||
| + | "message": "Login successful" | ||
| + | } | ||
| + | </code> | ||
| <code>400 Bad Request: Отсутствуют обязательные поля. | <code>400 Bad Request: Отсутствуют обязательные поля. | ||
| { | { | ||
| "error": "Email, UserID, and Password are required" | "error": "Email, UserID, and Password are required" | ||
| }</code> | }</code> | ||
| + | <code> | ||
| + | 400 Bad Request: Неверный ввод. | ||
| + | { | ||
| + | "error": "Invalid input" | ||
| + | } | ||
| + | </code> | ||
| + | <code> | ||
| + | 401 Unauthorized: Пользователь не найден или неверный пароль. | ||
| + | { | ||
| + | "error": "User not found" | ||
| + | } | ||
| + | </code> | ||
| <code>409 Conflict: Пользователь уже существует. | <code>409 Conflict: Пользователь уже существует. | ||
| { | { | ||
| Строка 49: | Строка 67: | ||
| }</code> | }</code> | ||
| - | ===== 2. Вход пользователя ==== | ||
| - | <code> | ||
| - | Эндпоинт: /user/login | ||
| - | Метод: POST | ||
| - | Входные параметры: | ||
| - | AccID (обязательный): Идентификатор аккаунта. | ||
| - | Email (обязательный): Электронная почта пользователя. | ||
| - | Password (обязательный): Пароль пользователя.</code> | ||
| - | **Пример запроса (формат формы):** | ||
| - | </code> | ||
| - | AccID=randomID | ||
| - | Email=random000@gmail.com | ||
| - | Password=random-password</code> | ||
| - | **Возможные ответы:** | ||
| - | <code>200 OK: Вход выполнен успешно. | + | ===== 2. Выход пользователя === |
| - | { | + | |
| - | "token": "exampleToken", | + | |
| - | "message": "Login successful" | + | |
| - | }</code> | + | |
| - | + | ||
| - | <code>400 Bad Request: Неверный ввод. | + | |
| - | { | + | |
| - | "error": "Invalid input" | + | |
| - | }</code> | + | |
| - | <code>401 Unauthorized: Пользователь не найден или неверный пароль. | + | |
| - | { | + | |
| - | "error": "User not found" | + | |
| - | }</code> | + | |
| - | ===== 3. Выход пользователя === | + | |
| <code> | <code> | ||
| - | Эндпоинт: /user/logout | + | Эндпоинт: /user/logout?id=1&token=12345678901234567890123456789012 |
| Метод: POST | Метод: POST | ||
| Входные параметры: | Входные параметры: | ||
| - | AccID (обязательный): Идентификатор аккаунта. | ||
| Email (обязательный): Электронная почта пользователя.</code> | Email (обязательный): Электронная почта пользователя.</code> | ||
| **Пример запроса (формат формы):** | **Пример запроса (формат формы):** | ||
| - | <code>AccID=randomID | + | <code> |
| Email=random000@gmail.com</code> | Email=random000@gmail.com</code> | ||
| **Возможные ответы:** | **Возможные ответы:** | ||
| Строка 96: | Строка 85: | ||
| <code>200 OK: Выход выполнен успешно. | <code>200 OK: Выход выполнен успешно. | ||
| { | { | ||
| + | "error": "", | ||
| "message": "Logout successful" | "message": "Logout successful" | ||
| }</code> | }</code> | ||
| Строка 104: | Строка 94: | ||
| }</code> | }</code> | ||
| - | ===== 4. Удаление пользователя == | + | ===== 3. Удаление пользователя == |
| - | <code>Эндпоинт: /user/delete | + | <code>Эндпоинт: /user/delete?id=1&token=12345678901234567890123456789012 |
| Метод: POST | Метод: POST | ||
| Входные параметры: | Входные параметры: | ||
| - | AccID (обязательный): Идентификатор аккаунта. | + | |
| Email (обязательный): Электронная почта пользователя.</code> | Email (обязательный): Электронная почта пользователя.</code> | ||
| **Пример запроса (формат формы):** | **Пример запроса (формат формы):** | ||
| - | <code>AccID=randomID | + | <code> |
| - | Email=random000@gmail.com<code> | + | Email=random000@gmail.com |
| + | </code> | ||
| **Возможные ответы:** | **Возможные ответы:** | ||
| <code>200 OK: Пользователь успешно удален. | <code>200 OK: Пользователь успешно удален. | ||
| { | { | ||
| + | "error": "", | ||
| "message": "User deleted successfully" | "message": "User deleted successfully" | ||
| }</code> | }</code> | ||
auth.1753081335.txt.gz · Последние изменения: 2025/07/21 07:02 — serg
Инструменты страницы
