@piousdeer/netschool-api v0.11.2

netschool-api

NetSchool (Russian online school journal service) Web API wrapper.

Обёртка Web API NetSchool.

Example

import NetSchool from '@piousdeer/netschool-api'

const ns = new NetSchool({
  // Страна (на сайте скрыта)
  country: 'Россия',
  // Регион
  state: 'Алтайский край',
  // Городской округ или муниципальный район
  area: 'Городской округ Барнаул',
  // Населённый пункт
  city: 'Барнаул, г.',
  // Тип образовательной организации
  type: 'Общеобразовательная',
  // Образовательная организация
  school: 'МБОУ СОШ № 91',
  // Пользователь
  username: 'Вася',
  // Пароль
  password: '1111'
}, {
  // Опциональный конфиг.
  origin: 'https://netschool.edu22.info',
  sessionLifetime: 5 * 60 * 1000
})

Usage

Ниже приведена краткая документация. Все типы, методы и их аргументы более подробно описаны в коде и JSDoc-комментариях.

NetSchool#fetchAnnouncements(amount)

Возвращает определённое количество последних объявлений.

NetSchool#fetchDiary(interval)

Возвращает дневник за определённый период.

NetSchool#getAttachmentUrl(attachment)

Возвращает ссылку для скачивания прикреплённого файла.

Diary#slice(interval)

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

Advanced usage

NetSchool#logout()

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

NetSchool#login()

Пытается залогиниться с указанной информацией. Библиотека сама вызывает этот метод, когда это надо.

NetSchool#getSession()

Возвращает сессию, если она валидна. Если невалидна, то делает новую.

NetSchool#fetch()

Фетчит что-либо релативно к ориджину, указанному в конфиге.