¶ Документация
¶ Документация пользователя
Проект расчитан на две категории потребителей:
- Внешние проекты. Это проекты-сервисы, которым интересны данные Цифрового Портфолио в целях аналитики и визуализации. Для таких проектов существует два способа интеграций - посредством
APIиIframe.В настоящее время такими проектами является Кабинет МИЭМ, Вики МИЭМ и Цифровой след: Аналитика - Участники учебного процесса. Любые участники учебного процесса (студенты, преподаватели и администрация) могут посмотреть данные по любому пользователю на веб-сайте Цифрового Портфолио
¶ Веб-сайт Цифровое Портфолио
Здесь описан функционал веб-сайта . Данная информация будет полезна студентам и преподавателям, а также сервисам, желающим вставить отдельные части сайта через iframe .
¶ Форматеры
Здесь приведена информация для потребителей, желающих воспользоваться API Цифрового Портфолио. Каждый форматер представляет из себя отдельный микросервис предназначенный для предоставления статистики по определенному сервису. В описании каждого форматера предоставлена информация о всех возможных запросах и описание их ответов. host можно узнать у администратора Цифрового Портфолио.
¶ Документация разработчика
Ниже описано устройство сервиса Форматеров и веб-сайта Цифрового Портфолио
¶ Алгоритм работы
- База данных MongoDB каждый день итеративно пополняется информацией от
проекта «Цифровой след»; - Внешние сервисы («Cabinet MIEM» или «Wiki MIEM») при желании получить
статистику по какому-либо сервису посылают запрос к API напрямую, либо обращаются к сайту «Цифрового Портфолио», который сам генерирует необходимые запросы; - Модуль API парсит запрос, обнаруживает желаемый сервис и перенаправляет запрос его форматеру;
- Форматер получает запрос от API, берет нужные данные из БД или аналитического модуля, проводит их обработку, подготавливает к визуализации и возвращает полученную статистику;
¶ Веб-сайт Цифровое Портфолио
¶ Форматтеры
¶ Аналитические модули
¶ Отчет
Отчет по проекту - 2022 год