nggtk-api
v1.0.0-readmefix
Published
Неофициальный враппер API НГТК от одного студента для студентов.
Downloads
6
Maintainers
Readme
Враппер НГТК API.
Неофициальный враппер API НГТК от одного студента для студентов.
Установка
- npm -
npm install nggtk-api
- yarn -
yarn add nggtk-api
Пример
const Nggtk = require("nggtk-api")
const nggtk = new Nggtk("URI_QUERY") // В ином случае, будет выводиться ошибка "Sender's signature is not correct".
await nggtk.getUserInfo()
Как получить URI_QUERY?
- Перейдите в приложение АИС SFM 2 через мобильную версию сайта ВКонтакте
- Откройте
DevTools
- Откройте вкладку
Network
- Выберите
Fetch/XHR
- Найдите пункт, начинающийся с
?vk_access_token_settings=
- Скопируйте весь текст, находящийся после
https://nggtk.ru/api/v2/METHOD_NAME/?
Список методов
Nggtk.checkUserVK()
- Проверка на то, что студент является пользователем ВКонтакте.
await nggtk.checkUserVK()
Nggtk.getUserInfo()
- Получение информации о студенте.
await nggtk.getUserInfo()
Nggtk.getTopBRSStudents()
- Получение топа студентов по баллам.
await nggtk.getTopBRSStudents()
Nggtk.getNews()
- Получение новостей.
await nggtk.getNews()
Nggtk.getAllNews()
- Получение всех новостей.
await nggtk.getAllNews()
Nggtk.getSlider()
- Получение слайдов с главной страницы.
await nggtk.getSlider()
Nggtk.getMyNotifications(type)
- Получение количества/? уведомлений.
const type = "count"
await nggtk.getMyNotifications(type)
Я без понятия, что может быть ещё.
Nggtk.getNewspaper()
- Получение газеты с главной страницы.
await nggtk.getNewspaper()
Nggtk.getAllEvents()
- Получение всех мероприятий.
await nggtk.getAllEvents()
Nggtk.getSchedule(group)
- Получить расписание определённой группы.
const group = "10ПК1"
await nggtk.getSchedule(group)
Nggtk.getTeachers(groupId)
- Получить преподавателей определённой группы.
const groupId = 900000
await nggtk.getTeachers(groupId)
Nggtk.changeNotifyScheduleState(value)
- Получать ли уведомления о изменении расписания?
const value = true
await nggtk.changeNotifyScheduleState(value)
Nggtk.getInfoPoints()
- Получение сводки баллов студента.
await nggtk.getInfoPoints()
Nggtk.getInfoPoints()
- Получение сводки баллов студента.
await nggtk.getInfoPoints()
Nggtk.getEventInfo(groupId)
- Получить преподавателей определённой группы.
const groupId = 5
await nggtk.getEventInfo(id)
Nggtk.getPortfolio()
- Получение портфолио студента.
await nggtk.getPortfolio()
Nggtk.getEvents()
- Получение мероприятий, в которых участвовал студент.
await nggtk.getEvents()
Nggtk.getExpelled()
- Получение информации о том, отчислен ли студент.
await nggtk.getExpelled()
Чую, что у меня скоро будет 1.
Nggtk.getAttendaceStudentInfo(action, period)
- Получение сводки о посещаемости студента.
const action = "TrafficPeriod"
const period = "ThisWeek"
await nggtk.getAttendaceStudentInfo(action, period)
Возможные action:
- DetailedAttendance - Детальная посещаемость.
Необходимо в period указывать дату, за которую надо получить сводку (ДД.ММ.ГГГГ)
- TrafficPeriod - Посещаемость за период.
Необходимо в period указывать
ThisWeek
(за эту неделю),ThisMonth
(за этот месяц),FirstSemester
(первый семестр),SecondSemester
(второй семестр)