Обзор

Эта страница предоставляет общую структуру нашего API.

Общая информация

  • Название: AiKYNETIX API

  • Версия: v1.0

  • Условия использования: https://aikynetix.app/terms

  • Контакт: [email protected]

  • URL сервера: https://aikpy-nsz2.onrender.com

  • Безопасность: Токен через заголовок API-KEY.


Конечные точки по группам функций

  • /user-management/organization-status/

    • GET: Получение статуса организации

  • /user-management/users/

    • GET: Получение списка пользователей с пагинацией

    • PUT: Обновление информации о пользователе

    • POST: Создание нового пользователя

    • DELETE: Удаление пользователя

  • /user-management/users/filter/

    • GET: Фильтрация и пагинация пользователей

  • /user-management/users/{user_uid}

    • GET: Получение деталей конкретного пользователя


  • Управление всеми сеансами

    • /session-management/sessions/

      • GET: Получение всех сеансов

    • /session-management/sessions/filter/

      • GET: Получение отфильтрованных сеансов

    • /session-management/sessions/{session_id}/

      • PUT: Обновление данных сеанса

      • DELETE: Удаление сеанса

  • Проанализированное видео

    • /session-management/sessions/{session_id}/analyzed-video/

      • GET: Получение URL проанализированного видео

      • POST: Загрузка/генерация проанализированного видео

  • Бег

    • /running/management/sessions/

      • POST: Создание нового сеанса обработки видео (администратор от имени другого пользователя)

    • /running/sessions/

      • POST: Создание нового сеанса обработки видео

    • /running/sessions/metrics/total/

      • GET: Получение общих метрик

    • /running/sessions/{session_id}/

      • GET: Получение деталей сеанса бега

    • /running/sessions/{session_id}/export/

      • GET: Экспорт данных сеанса бега

    • /running/sessions/{session_id}/form-analysis/

      • POST: Генерация изображений анализа формы (устарело)

    • /running/sessions/{session_id}/gait-analysis/

      • POST: Отчет об анализе походки

    • /running/sessions/{session_id}/metrics/

      • GET: Получение метрик отчета (устарело)

    • /running/sessions/{session_id}/recommendation/

      • POST: Генерация рекомендаций для сеанса (устарело)

    • /running/sessions/{session_id}/report-comments/

      • GET: Получение комментариев к сеансу

      • PUT: Обновление комментариев к сеансу

      • DELETE: Удаление комментариев к отчету

    • /running/sessions/{session_id}/report/

      • POST: Получение изображений анализа отчета (устарело)

    • /running/sessions/{session_id}/summary/

      • POST: Генерация сводки для сеанса (устарело)

  • Прыжки (вертикальный прыжок)

    • /jumping/management/sessions/

      • POST: Создание нового сеанса обработки видео (администратор от имени другого пользователя)

    • /jumping/sessions/

      • POST: Создание нового сеанса обработки видео

    • /jumping/sessions/{session_id}/

      • GET: Получение данных сеанса прыжков

    • /jumping/sessions/{session_id}/export/

      • GET: Экспорт данных сеанса прыжков

    • /jumping/sessions/{session_id}/jump-analysis/

      • POST: Получение отчета об анализе вертикального прыжка

    • /jumping/sessions/{session_id}/recommendation/

      • POST: Создание потоков рекомендаций

    • /jumping/sessions/{session_id}/summary/

      • GET: Получение сводки сеанса

      • POST: Генерация потоков сводки для сеанса

  • Тяжелая атлетика

    • /weightlifting/management/sessions/

      • POST: Создание нового сеанса обработки видео (администратор от имени другого пользователя)

    • /weightlifting/sessions/

      • POST: Создание нового сеанса обработки видео

    • /weightlifting/sessions/{session_id}/

      • GET: Получение деталей сеанса тяжелой атлетики

    • /weightlifting/sessions/{session_id}/export/

      • GET: Экспорт данных сеанса тяжелой атлетики

    • /weightlifting/sessions/{session_id}/lift-analysis/

      • POST: Анализ подъема в тяжелой атлетике

    • /weightlifting/sessions/{session_id}/recommendation/

      • POST: Генерация рекомендаций для тяжелой атлетики


  • /helper/html-files/

    • GET: Получение HTML-файла

    • POST: Загрузка HTML-файла


Компоненты

  • Схемы безопасности: Токен (передается в заголовке API-KEY)

Last updated

Was this helpful?