Skip to content

falpin/timetable-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API для работы с расписанием ЧЭнК

Этот API предоставляет возможность получать и сохранять данные о группах и расписании занятий для учебного заведения ЧЭнК. На данный момент доступно 6 запросов, включая проверку работоспособности API, получение и сохранение данных о группах и расписании

Базовый URL

Все запросы выполняются к базовому URL: falpin.ru/api

Доступные запросы

1. Проверка работоспособности API

Метод: GET
URL: /api
Описание: Этот запрос используется для проверки работоспособности API

2. Получение списка всех групп

Метод: GET
URL: /api/get_groups
Описание: Этот запрос возвращает список всех групп, доступных в системе

3. Получение информации о выбранной группе

Метод: POST
URL: /api/get_groups
Описание: Этот запрос возвращает информацию о конкретной группе Параметры запроса:

  • group (строка): Название группы Тело запроса:
{
  "group": "ИСП-2-24"
}

4. Получение расписания для выбранной группы

Метод: POST
URL: /api/get_schedule
Описание: Этот запрос возвращает расписание для указанной группы на указанную неделю. Если неделя не указана, возвращается расписание на текущую неделю Параметры запроса:

  • group (строка): Название группы
  • week (число, опционально): Номер недели Тело запроса:
{
  "group": "ИСП-2-24",
  "week": 6 //если не указать, то запрос будет на текущую неделю
}

5. Сохранение списка групп

Метод: POST
URL: /api/save_groups
Описание: Этот запрос позволяет сохранить список групп в системе. Требуется API-ключ для авторизации Заголовки запроса:

  • X-API-Key: Ваш секретный API-ключ. Параметры запроса:
  • complex (строка): Название комплекса
  • 1 курс2 курс3 курс4 курс5 курс (объекты): Список групп для каждого курса Тело запроса:
{
  "complex": "Российская",
  "1 курс": {
    "ИСП-2-24": "view.php?gr=362&dep=3",
    "ИСП-7-24": "view.php?gr=343&dep=3"
    }
}

6. Сохранение расписания для выбранной группы

Метод: POST
URL: /api/save_schedule
Описание: Этот запрос позволяет сохранить расписание для указанной группы на указанную неделю. Требуется API-ключ для авторизации
Заголовки запроса:

  • X-API-Key: Ваш секретный API-ключ Параметры запроса:
  • group (строка): Название группы
  • week (число): Номер недели
  • Расписание (объект): Расписание занятий на каждый день недели Тело запроса:
{
  "group": "ИСП-8-21",
  "week": 6,
  "10 Февраля, Понедельник": {
    "4": {
      "time_start": "14.00",
      "time_finish": "15.10",
      "lessons": {
        "Менеджмент": {
          "Богачева Е.А.": ""
        }
      }
    }
  }
}

Сохранение данных

Все передаваемые данные, сохраняются на сервере. Это нужно для более быстрой связи между клиентом и сервером, так как не приходится парсить сайт с расписанием при каждом запросе

Обратная связь

Если у вас возникли вопросы или предложения по улучшению API, пожалуйста, свяжитесь с разработчиком


Примечание: Убедитесь, что ваш API-ключ хранится в безопасности и не передается третьим лицам

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages