Управление пользователями
Общее управление пользователями
Получить постраничный список пользователей
Этот эндпоинт позволяет администратору получить постраничный список пользователей под его аккаунтом. Ответ включает детальную информацию о каждом пользователе, такую как персональные атрибуты, контактные данные и метаданные, связанные с их аккаунтом.
Пример использования: Отправьте GET запрос на client-management/clients/ с соответствующим API-KEY токеном в заголовке Authorization.
Структура ответа:
users (массив): Список объектов пользователей, где каждый объект включает следующие поля:
created_at (строка, дата-время): Временная метка создания пользователя.
weight (число): Вес пользователя.
age (строка): Возраст пользователя.
ycom (число): Значение YCOM пользователя.
height (число): Рост пользователя.
phone (строка): Номер телефона пользователя.
leg_length (число): Длина ноги пользователя.
display_name (строка): Отображаемое имя пользователя.
shoeSize (строка): Размер обуви пользователя.
email (строка): Адрес электронной почты пользователя.
gender (строка): Пол пользователя.
brand (строка): Бренд, связанный с пользователем.
shoeModel (строка): Модель обуви пользователя.
user_uid (строка): Уникальный идентификатор пользователя.
Примечания:
Для доступа к этому эндпоинту требуется действительный API-KEY токен.
Если пользователи не найдены или произошла ошибка, возвращается соответствующее сообщение об ошибке.
Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>
Список пользователей успешно получен.
Неверный запрос - Некорректные параметры запроса или отсутствуют обязательные данные.
Не авторизован - Отсутствует или недействительный токен доступа.
Запрещено - Пользователь не имеет необходимых прав доступа.
Не найдено - Пользователи не найдены или произошла ошибка при получении.
Внутренняя ошибка сервера - Произошла непредвиденная ошибка.
GET /client-management/clients/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*
{
"users": [
{
"created_at": "2026-01-01T00:00:00.000Z",
"weight": 1,
"age": "text",
"ycom": 1,
"height": 1,
"phone": "text",
"leg_length": 1,
"display_name": "text",
"shoeSize": "text",
"email": "name@gmail.com",
"gender": "text",
"brand": "text",
"shoeModel": "text",
"profile_photo": "https://example.com",
"user_uid": "text"
}
]
}Создать нового пользователя
Этот эндпоинт позволяет аутентифицированному администратору создать нового пользователя под своим аккаунтом. Администратор должен указать email и отображаемое имя пользователя, а также может включить другие поля.
Пример использования: Отправьте POST запрос на /clients/ с JSON-данными, содержащими обязательные поля. В заголовке Authorization должен быть указан действительный API-KEY токен.
Параметры запроса
display_name (строка)
email (строка, валидный email)
age (целое число)
gender (male | female)
shoeSize (число с плавающей точкой)
weight (число с плавающей точкой)
height (число с плавающей точкой)
Структура ответа: При успешном выполнении (HTTP 201), эндпоинт возвращает JSON-объект с полем userData, содержащим следующие ключи и типы данных:
user_uid (строка): Уникальный идентификатор нового пользователя.
display_name (строка)
email (строка, валидный email)
age (целое число)
gender (male | female)
shoeSize (число с плавающей точкой)
weight (число с плавающей точкой)
height (число с плавающей точкой)
profile_photo (файл, JPEG/PNG) - необязательное изображение; доступно только с
multipart/form-data.
В случае ошибки (например, отсутствуют параметры, неавторизованный доступ или внутренняя ошибка), возвращается JSON-объект с полем error (строка).
Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>
Необязательный JSON-кодированный список предпочитаемых типов активности. Допустимые значения: 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'.
Пример: ["Running", "Weightlifting"]
Необязательное изображение JPEG/PNG.
Пользователь успешно создан.
Неверный запрос - Отсутствуют или некорректные параметры.
Не авторизован - Отсутствует или недействительный токен доступа.
Запрещено - Пользователь не имеет прав на создание пользователей.
Не найдено - Достигнут лимит создания пользователей для Pro плана.
Внутренняя ошибка сервера - Произошла непредвиденная ошибка.
POST /client-management/clients/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 151
"display_name='text'&email='text'&age=1&gender='text'&shoeSize=1&weight=1&height=1&preferable_activities='text'&profile_photo='text'"{
"userData": {
"user_uid": "text",
"display_name": "text",
"email": "text",
"age": 1,
"gender": "text",
"shoeSize": 1,
"weight": 1,
"height": 1,
"profile_photo": "https://example.com",
"preferable_activities": [
"text"
]
}
}Обновить информацию о пользователе
Этот эндпоинт позволяет аутентифицированному администратору обновить выбранные поля существующего пользователя, используя параметры строки запроса.
Обязательный параметр запроса
user_uid (строка) - UID пользователя, которого нужно обновить.
Необязательные параметры запроса - укажите один или несколько из следующих:
display_name (строка) - новое отображаемое имя
email (строка, валидный email) - новый адрес электронной почты
age (целое число)
gender (строка, одно из
male,female)shoeSize (число с плавающей точкой)
weight (число с плавающей точкой)
height (число с плавающей точкой)
Ответ (HTTP 200)
{ "message": "Информация о пользователе успешно обновлена." }Если проверка не пройдена или пользователь не найден, ответ содержит поле error с деталями.
Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>
Необязательный JSON-кодированный список предпочитаемых типов активности. Допустимые значения: 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'.
Пример: ["Running", "Weightlifting"]
Необязательное изображение JPEG/PNG.
Информация о пользователе успешно обновлена.
Сообщение, подтверждающее успешное обновление.
Неверный запрос - Отсутствуют обязательные поля или неверные данные.
Не авторизован - Отсутствует или недействительный токен доступа.
Запрещено - Пользователь не имеет прав на обновление информации о пользователе.
Внутренняя ошибка сервера - Произошла непредвиденная ошибка.
PUT /client-management/clients/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 169
"user_uid='text'&display_name='text'&email='text'&age=1&gender='text'&shoeSize=1&weight=1&height=1&preferable_activities='text'&profile_photo='text'"{
"message": "text"
}Удалить пользователя
Этот эндпоинт позволяет аутентифицированному администратору удалить пользователя из своего аккаунта. Администратор должен указать уникальный идентификатор пользователя, которого нужно удалить, в теле запроса.
Тело запроса:
user_uid (строка, обязательно): Уникальный идентификатор пользователя, которого нужно удалить.
Структура ответа: При успешном выполнении (HTTP 200), эндпоинт возвращает JSON-объект с полем message типа string, подтверждающим удаление. В случае ошибки (например, если UID пользователя отсутствует, пользователь не найден или произошла внутренняя ошибка), возвращается JSON-объект с полем error (строка).
Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>
UID пользователя для удаления
Пользователь успешно удален.
Сообщение, подтверждающее, что пользователь был удален.
Неверный запрос - Отсутствует обязательный UID пользователя.
Не авторизован - Отсутствует или недействительный токен доступа.
Запрещено - Пользователь не имеет прав на удаление пользователей.
Не найдено - Пользователь не найден или не принадлежит администратору.
Внутренняя ошибка сервера - Произошла непредвиденная ошибка.
DELETE /client-management/clients/?user_uid=text HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "text"
}Фильтрация и постраничное получение пользователей
Этот эндпоинт позволяет аутентифицированному администратору фильтровать и получать постранично пользователей под своим аккаунтом. Вы можете дополнительно указать параметры запроса для управления пагинацией:
start_after_id (строка, необязательно): UID, после которого начинается получение пользователей (для прямой пагинации).
limit (целое число, необязательно): Максимальное количество пользователей для получения. По умолчанию 5, если не указано.
Вы также можете фильтровать пользователей по различным критериям, таким как:
admin_uid (строка, необязательно): UID администратора для фильтрации пользователей.
start_date (строка, необязательно): Нижняя граница (включительно) для последней сессии пользователя в формате
YYYY-MM-DD.end_date (строка, необязательно): Верхняя граница (включительно) для последней сессии пользователя в формате
YYYY-MM-DD.gender (строка, необязательно): Фильтр по полу (
maleилиfemale).preferable_activities (массив, необязательно): Фильтр по предпочитаемым активностям пользователя. Структура ответа (HTTP 200): Ответ возвращает JSON-объект со следующими полями:
query_count (целое число): Общее количество пользователей под администратором.
users (массив): Массив объектов пользователей. Каждый объект пользователя содержит:
created_at (строка, дата-время): Временная метка создания пользователя.
weight (число): Вес пользователя.
age (строка): Возраст пользователя.
ycom (число): Значение YCOM пользователя.
height (число): Рост пользователя.
phone (строка): Номер телефона пользователя.
leg_length (число): Длина ноги пользователя.
display_name (строка): Отображаемое имя пользователя.
shoeSize (строка): Размер обуви пользователя.
email (строка): Адрес электронной почты пользователя.
gender (строка): Пол пользователя.
brand (строка): Бренд, связанный с пользователем.
shoeModel (строка): Модель обуви пользователя.
user_uid (строка): Уникальный идентификатор пользователя.
first_uid (строка): UID первого пользователя на текущей странице.
last_uid (строка): UID последнего пользователя на текущей странице.
Примечания:
Требуется действительный API-KEY токен.
Если пользователи не найдены, возвращается сообщение об ошибке с кодом состояния 404.
Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>
UID администратора (который создал пользователя) для фильтрации пользователей.
Нижняя граница (включительно) для last_session в формате YYYY-MM-DD.
Верхняя граница (включительно) для last_session в формате YYYY-MM-DD.
Фильтр по полу (male или female).
JSON-массив предпочитаемых активностей.
Успешно получен отфильтрованный список пользователей.
Общее количество пользователей под администратором.
UID первого пользователя на текущей странице.
UID последнего пользователя на текущей странице.
Не авторизован - Отсутствует или недействительный токен доступа.
Запрещено - Запрашивающий не имеет прав администратора.
Не найдено - Пользователи не найдены под администратором или произошла ошибка при получении.
Внутренняя ошибка сервера - Произошла непредвиденная ошибка при получении.
GET /client-management/clients/filter/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*
{
"query_count": 1,
"users": [
{
"created_at": "2026-01-01T00:00:00.000Z",
"weight": 1,
"age": "text",
"ycom": 1,
"height": 1,
"phone": "text",
"leg_length": 1,
"display_name": "text",
"shoeSize": "text",
"email": "name@gmail.com",
"gender": "text",
"brand": "text",
"shoeModel": "text",
"profile_photo": "https://example.com",
"user_uid": "text"
}
],
"first_uid": "text",
"last_uid": "text"
}Сохраняет одну заметку на клиента. Если note опущен или пуст, предыдущая заметка очищается (сохраняется как null).
Структура документа:
"notes": {
"text": "Растяжение подколенного сухожилия - уменьшить скоростные нагрузки на 2 недели", // или null
"updated_at": "2025-07-14T09:32:11.123Z"
}Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>
Произвольный текст заметки (≤ 100 kB). Если опущен или пуст, заметка очищается.
Заметка сохранена / заменена успешно.
Неверный запрос - UID пользователя отсутствует или недействителен.
Не авторизован - Отсутствует или недействительный токен.
Запрещено - Запрашивающий не имеет прав администратора.
Не найдено - Пользователь не найден или не принадлежит администратору.
Внутренняя ошибка сервера - Произошла непредвиденная ошибка.
POST /client-management/clients/save-notes/{user_uid} HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"note": "Растяжение подколенного сухожилия - уменьшить скоростные нагрузки на 2 недели"
}{
"message": "text"
}Получить детали пользователя
Этот эндпоинт позволяет аутентифицированному администратору получить детальную информацию о конкретном пользователе под его аккаунтом. Пользователь идентифицируется уникальным user_uid, указанным в URL.
Параметр пути:
user_uid (строка, обязательно): Уникальный идентификатор пользователя.
Структура ответа (HTTP 200): Возвращает JSON-объект со следующими полями и типами данных:
created_at (строка, дата-время): Временная метка создания пользователя.
weight (число): Вес пользователя.
age (строка): Возраст пользователя.
ycom (число): Значение YCOM пользователя.
height (число): Рост пользователя.
phone (строка): Номер телефона пользователя.
leg_length (число): Длина ноги пользователя.
display_name (строка): Отображаемое имя пользователя.
shoeSize (строка): Размер обуви пользователя.
email (строка): Адрес электронной почты пользователя.
gender (строка): Пол пользователя.
brand (строка): Бренд, связанный с пользователем.
shoeModel (строка): Модель обуви пользователя.
user_uid (строка): Уникальный идентификатор пользователя.
Пример успешного ответа:
Примечания:
Требуется действительный API-KEY токен с правами администратора.
Если указанный пользователь не существует или не принадлежит администратору, возвращается ошибка 404.
Укажите ваш Bearer-токен (Firebase auth) в формате: Bearer <токен>
Детали пользователя успешно получены.
Временная метка создания пользователя.
Вес пользователя.
Возраст пользователя.
Значение YCOM пользователя.
Рост пользователя.
Номер телефона пользователя.
Длина ноги пользователя.
Отображаемое имя пользователя.
Размер обуви пользователя.
Адрес электронной почты пользователя.
Пол пользователя.
Бренд, связанный с пользователем.
Модель обуви пользователя.
Публичный URL фотографии профиля.
Уникальный идентификатор пользователя.
Неверный запрос - UID пользователя отсутствует или недействителен.
Не авторизован - Отсутствует или недействительный токен.
Запрещено - Запрашивающий не имеет прав администратора.
Не найдено - Пользователь не найден или не принадлежит администратору.
Внутренняя ошибка сервера - Произошла непредвиденная ошибка.
GET /client-management/clients/{user_uid} HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*
{
"created_at": "2026-01-01T00:00:00.000Z",
"weight": 1,
"age": "text",
"ycom": 1,
"height": 1,
"phone": "text",
"leg_length": 1,
"display_name": "text",
"shoeSize": "text",
"email": "name@gmail.com",
"gender": "text",
"brand": "text",
"shoeModel": "text",
"profile_photo": "https://example.com",
"user_uid": "text"
}Last updated
Was this helpful?