Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tailsjs/nggtk-api
Неофициальный враппер API НГТК от одного студента для студентов.
https://github.com/tailsjs/nggtk-api
Last synced: about 2 months ago
JSON representation
Неофициальный враппер API НГТК от одного студента для студентов.
- Host: GitHub
- URL: https://github.com/tailsjs/nggtk-api
- Owner: tailsjs
- Created: 2023-08-31T08:01:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-10T22:04:55.000Z (over 1 year ago)
- Last Synced: 2024-10-31T17:36:39.494Z (2 months ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Враппер НГТК API.
Неофициальный враппер API НГТК от одного студента для студентов.
## Установка
* npm - `npm install nggtk-api`
* yarn - `yarn add nggtk-api`
## Пример
```js
const Nggtk = require("nggtk-api")
const nggtk = new Nggtk("URI_QUERY") // В ином случае, будет выводиться ошибка "Sender's signature is not correct".
await nggtk.getUserInfo()
```
## Как получить URI_QUERY?
1. Перейдите в приложение АИС SFM 2 через мобильную версию сайта ВКонтакте
2. Откройте `DevTools`
3. Откройте вкладку `Network`
4. Выберите `Fetch/XHR`
5. Найдите пункт, начинающийся с `?vk_access_token_settings=`
6. Скопируйте весь текст, находящийся после `https://nggtk.ru/api/v2/METHOD_NAME/?`
## Список методов
### Nggtk.checkUserVK()
* Проверка на то, что студент является пользователем ВКонтакте.
```js
await nggtk.checkUserVK()
```
### Nggtk.getUserInfo()
* Получение информации о студенте.
```js
await nggtk.getUserInfo()
```
### Nggtk.getTopBRSStudents()
* Получение топа студентов по баллам.
```js
await nggtk.getTopBRSStudents()
```
### Nggtk.getNews()
* Получение новостей.
```js
await nggtk.getNews()
```
### Nggtk.getAllNews()
* Получение всех новостей.
```js
await nggtk.getAllNews()
```
### Nggtk.getSlider()
* Получение слайдов с главной страницы.
```js
await nggtk.getSlider()
```
### Nggtk.getMyNotifications(type)
* Получение количества/? уведомлений.
```js
const type = "count"
await nggtk.getMyNotifications(type)
```
> Я без понятия, что может быть ещё.
### Nggtk.getNewspaper()
* Получение газеты с главной страницы.
```js
await nggtk.getNewspaper()
```
### Nggtk.getAllEvents()
* Получение всех мероприятий.
```js
await nggtk.getAllEvents()
```
### Nggtk.getSchedule(group)
* Получить расписание определённой группы.
```js
const group = "10ПК1"
await nggtk.getSchedule(group)
```
### Nggtk.getTeachers(groupId)
* Получить преподавателей определённой группы.
```js
const groupId = 900000
await nggtk.getTeachers(groupId)
```
### Nggtk.changeNotifyScheduleState(value)
* Получать ли уведомления о изменении расписания?
```js
const value = true
await nggtk.changeNotifyScheduleState(value)
```
### Nggtk.getInfoPoints()
* Получение сводки баллов студента.
```js
await nggtk.getInfoPoints()
```
### Nggtk.getInfoPoints()
* Получение сводки баллов студента.
```js
await nggtk.getInfoPoints()
```
### Nggtk.getEventInfo(groupId)
* Получить преподавателей определённой группы.
```js
const groupId = 5
await nggtk.getEventInfo(id)
```
### Nggtk.getPortfolio()
* Получение портфолио студента.
```js
await nggtk.getPortfolio()
```
### Nggtk.getEvents()
* Получение мероприятий, в которых участвовал студент.
```js
await nggtk.getEvents()
```
### Nggtk.getExpelled()
* Получение информации о том, отчислен ли студент.
```js
await nggtk.getExpelled()
```
> Чую, что у меня скоро будет 1.
### Nggtk.getAttendaceStudentInfo(action, period)
* Получение сводки о посещаемости студента.
```js
const action = "TrafficPeriod"
const period = "ThisWeek"
await nggtk.getAttendaceStudentInfo(action, period)
```
Возможные action:
1. DetailedAttendance - Детальная посещаемость.
> Необходимо в period указывать дату, за которую надо получить сводку (ДД.ММ.ГГГГ)
2. TrafficPeriod - Посещаемость за период.
> Необходимо в period указывать `ThisWeek` (за эту неделю), `ThisMonth` (за этот месяц), `FirstSemester` (первый семестр), `SecondSemester` (второй семестр)
## Полезные ссылки
* [Сайт НГТК](https://nggtk.ru/)