Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
auth [2025/07/18 14:07] 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 | + | Эндпоинт: /user/login?id=1&token=12345678901234567890123456789012 |
| Метод: POST | Метод: POST | ||
| Входные параметры: | Входные параметры: | ||
| - | |||
| - | AccID (обязательный): Идентификатор аккаунта (может передаваться в URL или форме). | ||
| Email (обязательный): Электронная почта пользователя. | Email (обязательный): Электронная почта пользователя. | ||
| UserID (обязательный): Уникальный идентификатор пользователя. | UserID (обязательный): Уникальный идентификатор пользователя. | ||
| Строка 16: | Строка 14: | ||
| OSInt (обязательный): Целочисленный идентификатор операционной системы. | OSInt (обязательный): Целочисленный идентификатор операционной системы. | ||
| GAID (обязательный): Идентификатор устройства Google. | GAID (обязательный): Идентификатор устройства Google. | ||
| + | Gaidtype (обязательный) | ||
| SDKVerC (необязательный): Версия SDK.</code> | SDKVerC (необязательный): Версия SDK.</code> | ||
| **Пример запроса (формат формы):** | **Пример запроса (формат формы):** | ||
| - | ''AccID=randomID | + | <code> |
| Email=random000@gmail.com | Email=random000@gmail.com | ||
| UserID=random-firebase-user-id000 | UserID=random-firebase-user-id000 | ||
| Строка 25: | Строка 24: | ||
| OSInt=1 | OSInt=1 | ||
| GAID=Random-Device-ID000 | GAID=Random-Device-ID000 | ||
| - | SDKVerC=1.0.0'' | + | SDKVerC=1.0.0</code> |
| **Возможные ответы:** | **Возможные ответы:** | ||
| - | ''200 OK: Пользователь успешно создан. | + | <code>200 OK: Пользователь успешно создан. |
| { | { | ||
| + | "error": "", | ||
| "token": "exampleToken", | "token": "exampleToken", | ||
| "message": "User created successfully" | "message": "User created successfully" | ||
| - | }'' | + | }</code> |
| - | + | <code>200 OK: Вход выполнен успешно. | |
| - | ''400 Bad Request: Отсутствуют обязательные поля. | + | { |
| + | "error": "", | ||
| + | "token": "exampleToken", | ||
| + | "message": "Login successful" | ||
| + | } | ||
| + | </code> | ||
| + | <code>400 Bad Request: Отсутствуют обязательные поля. | ||
| { | { | ||
| "error": "Email, UserID, and Password are required" | "error": "Email, UserID, and Password are required" | ||
| - | }'' | + | }</code> |
| - | + | <code> | |
| - | ''409 Conflict: Пользователь уже существует. | + | 400 Bad Request: Неверный ввод. |
| + | { | ||
| + | "error": "Invalid input" | ||
| + | } | ||
| + | </code> | ||
| + | <code> | ||
| + | 401 Unauthorized: Пользователь не найден или неверный пароль. | ||
| + | { | ||
| + | "error": "User not found" | ||
| + | } | ||
| + | </code> | ||
| + | <code>409 Conflict: Пользователь уже существует. | ||
| { | { | ||
| "error": "User already exists" | "error": "User already exists" | ||
| - | }'' | + | }</code> |
| - | ''500 Internal Server Error: Ошибка при создании пользователя. | + | <code>500 Internal Server Error: Ошибка при создании пользователя. |
| { | { | ||
| "error": "Failed to create user" | "error": "Failed to create user" | ||
| - | }'' | + | }</code> |
| - | ==== 2. Вход пользователя ==== | ||
| - | '' | ||
| - | Эндпоинт: /user/login | ||
| - | Метод: POST | ||
| - | Входные параметры: | ||
| - | AccID (обязательный): Идентификатор аккаунта. | ||
| - | Email (обязательный): Электронная почта пользователя. | ||
| - | Password (обязательный): Пароль пользователя.'' | ||
| - | **Пример запроса (формат формы):** | ||
| - | '' | ||
| - | AccID=randomID | ||
| - | Email=random000@gmail.com | ||
| - | Password=random-password'' | ||
| - | **Возможные ответы:** | ||
| - | ''200 OK: Вход выполнен успешно. | + | ===== 2. Выход пользователя === |
| - | { | + | <code> |
| - | "token": "exampleToken", | + | Эндпоинт: /user/logout?id=1&token=12345678901234567890123456789012 |
| - | "message": "Login successful" | + | |
| - | }'' | + | |
| - | + | ||
| - | ''400 Bad Request: Неверный ввод. | + | |
| - | { | + | |
| - | "error": "Invalid input" | + | |
| - | }'' | + | |
| - | ''401 Unauthorized: Пользователь не найден или неверный пароль. | + | |
| - | { | + | |
| - | "error": "User not found" | + | |
| - | }'' | + | |
| - | === 3. Выход пользователя === | + | |
| - | '' | + | |
| - | Эндпоинт: /user/logout | + | |
| Метод: POST | Метод: POST | ||
| Входные параметры: | Входные параметры: | ||
| - | AccID (обязательный): Идентификатор аккаунта. | + | Email (обязательный): Электронная почта пользователя.</code> |
| - | Email (обязательный): Электронная почта пользователя.'' | + | |
| **Пример запроса (формат формы):** | **Пример запроса (формат формы):** | ||
| - | ''AccID=randomID | + | <code> |
| - | Email=random000@gmail.com'' | + | Email=random000@gmail.com</code> |
| **Возможные ответы:** | **Возможные ответы:** | ||
| - | ''200 OK: Выход выполнен успешно. | + | <code>200 OK: Выход выполнен успешно. |
| { | { | ||
| + | "error": "", | ||
| "message": "Logout successful" | "message": "Logout successful" | ||
| - | }'' | + | }</code> |
| - | ''400 Bad Request: Неверный ввод. | + | <code>400 Bad Request: Неверный ввод. |
| { | { | ||
| "error": "Invalid input" | "error": "Invalid input" | ||
| - | }'' | + | }</code> |
| - | == 4. Удаление пользователя == | + | ===== 3. Удаление пользователя == |
| - | ''Эндпоинт: /user/delete | + | <code>Эндпоинт: /user/delete?id=1&token=12345678901234567890123456789012 |
| Метод: POST | Метод: POST | ||
| Входные параметры: | Входные параметры: | ||
| - | AccID (обязательный): Идентификатор аккаунта. | + | |
| - | Email (обязательный): Электронная почта пользователя.'' | + | Email (обязательный): Электронная почта пользователя.</code> |
| **Пример запроса (формат формы):** | **Пример запроса (формат формы):** | ||
| - | ''AccID=randomID | + | <code> |
| - | Email=random000@gmail.com'' | + | Email=random000@gmail.com |
| + | </code> | ||
| **Возможные ответы:** | **Возможные ответы:** | ||
| - | ''200 OK: Пользователь успешно удален. | + | <code>200 OK: Пользователь успешно удален. |
| { | { | ||
| + | "error": "", | ||
| "message": "User deleted successfully" | "message": "User deleted successfully" | ||
| - | }'' | + | }</code> |
| - | ''400 Bad Request: Неверный ввод. | + | <code>400 Bad Request: Неверный ввод. |
| { | { | ||
| "error": "Invalid input" | "error": "Invalid input" | ||
| - | }'' | + | }</code> |
| - | ''500 Internal Server Error: Ошибка при удалении пользователя. | + | <code>500 Internal Server Error: Ошибка при удалении пользователя. |
| { | { | ||
| "error": "Failed to delete user" | "error": "Failed to delete user" | ||
| - | }'' | + | }</code> |