Giter VIP home page Giter VIP logo

netschoolapi's Introduction

NetSchoolApi - Враппер для продукта "Сетевой город. Образование"

NetSchoolApi - это враппер для продукта "Сетевой город. Образование", предоставляющий доступ к информации о пользователе, такой как дневник, расписание и другие данные.

Начало работы

Следующие инструкции помогут вам запустить проект на вашем локальном компьютере для разработки и тестирования.

Предварительные условия

Перед установкой и использованием этой библиотеки убедитесь, что у вас установлены следующие компоненты:

  • Node.js версии 10.24.1 или выше

Установка

Вы можете установить библиотеку с помощью следующей команды:

npm i netschoolapi

Проверка установки

  1. Создайте файл test.js в корне проекта.
  2. Вставьте следующий код в файл test.js, заменив данные на ваши:
const NS = require("netschoolapi").default;
const user = new NS({
  origin: "https://example.com/", // Origin вашего сайта
  login: "Иванов", // Ваш логин
  password: "******", // Ваш пароль
  school: "МБОУ ....", // Название вашей школы (как на сайте)
});

(async function () {
  const info = await user.info();
  console.log(info);
})();
  1. Запустите этот код в консоли с помощью следующей команды:
node test.js
  1. Если в консоли не выводится информация о пользователе, убедитесь, что у вас установлена подходящая версия NodeJS, либо создайте issue на GitHub.

Дополнительная информация о библиотеке

Зависимости

Для работы этой библиотеки используются следующие зависимости:

  • ws - Клиентская реализация WebSocket
  • node-fetch - Fetch API в Node.js
  • node-html-parser - Генерация упрощенного DOM-дерева с поддержкой запросов к элементам.

Управление версиями

Версии этой библиотеки управляются согласно SemVer. Список доступных версий можно найти в разделе теги.

Авторы

Также посмотрите список участников, которые внесли свой вклад в проект.

Лицензия

Этот проект распространяется под лицензией MIT. Подробную информацию смотрите в файле LICENSE.

Помощь/Общение

Для получения помощи и общения присоединяйтесь к Telegram-чату

netschoolapi's People

Contributors

artegoser avatar dependabot[bot] avatar lentryd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

coderco

netschoolapi's Issues

Невозможно открыть сессию пользователя

Описание ошибки
Как понимаю, не получается открыть сессию, поэтому код падает.
Код взят полностью из README, простое получение данных о пользователе.

Скриншоты/Логи

Снимок экрана 2022-09-22 в 12 09 11

Информация о среде:

  • Среда: локальный пк, macos
  • Версия NodeJS v16.15.1
  • Версия библиотеки ^1.7.1

ETIMEDOUT вне России.

При попытке использования API на сервере Heroku выдаёт ошибку ETIMEDOUT. Из России всё работает, на Heroku ни США, ни Европа не срабатывают. user.diary() зависает до момента краша с вышеуказанной причиной.

OS: Linux 64bit
Node.js version: 18.1.0.
VPN, антивирусов, прокси и прочих источников gayтовских зараз нет.

status: 403

node ocenTop.js
 INFO  Класс пользователя ИМЯ создан

Error: Fetch failed.
        - url: https://sgo.rso23.ru/webapi/schools/search
        - status: 403
    at Client.<anonymous> (/var/www/ocenki/data/node_modules/netschoolapi/dist/classes/Client/index.js:109:23)
    at Generator.next (<anonymous>)
    at fulfilled (/var/www/ocenki/data/node_modules/netschoolapi/dist/classes/Client/index.js:5:58)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
 ERROR  Ошибка в коде привела к закрытию программы
Error: Не удалось получить список школ
    at /var/www/ocenki/data/node_modules/netschoolapi/dist/methods/logIn/methods/schoolInfo.js:23:19
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
 DONE  Сеанс ИМЯ успешно закрыт

Выдаёт такое. Через браузер с этого IP и логина подключается.

Запрос информации за прошлые учебные года

Здравствуйте!

const classRes = await user.fetch("/webapi/classes?expand=chiefs");
var classes = $.parseJSON(await classRes.text());

Этим кодом я могу получить список классов и их id. Но как мне можно получить список классов за прошлые года?

p.s. И хотелось бы иметь возможность запрашивать отчёты через user.reportFile для прошлых лет.

Вывод Diary через .toJSON

В логе полученном через .toJSON в методе Diary

Запраишваю вывод в json он выводит

toJSON() {
return {
id: this.id,
subject: this.subject,
endDate: this._endDate,
startDate: this._startDate,
assignments: this.assignments.map((a) => a.toJSON()),
};
}

Если без toJSON то Lesson {id: 7999784, subject: 'Алгебра', _endDate: '2022-10-25T11:15:00', _startDate: '2022-10-25T10:35:00', assignments: Array(1)}

Скриншоты/Логи
изображение
код:

const NS = require("netschoolapi").default;
const user = new NS({
origin: "http://188.226.50.152/", // Origin вашего сайта
login: "", // Ваш логин
password: "", // Ваш пароль
school: "МБОУ Гимназия", // Название вашей школы (как на сайте)
});

(async function () {
// Получаем дневник
const di = await user.diary();
console.log(di.days[0].lessons[3].toJSON)

await user.logOut();
})();

  • Среда: VSC
  • Версия NodeJS 18.2.0
  • OS Windows 11

Может конечно я идиот но фиг знает

Как обрабатывать ошибки?

Подскажите пожалуйста как обрабатывать ошибки.

Например у меня есть цикл и я делаю подряд много запросов var result = await user.reportFile({
Иногда на каком-то запросе происходит задержка, и вдруг скрипт прекращается выдав "DONE Сеанс ЛОГИН успешно закрыт". Если запустить повторно, то может дойти до конца, а может снова вылететь в другом месте.

Как обработать неудачный запрос reportFile и сразу повторить с этого же места?

Как обрабатывать ошибки метода reportFile?

Таким кодом делаю повторные запросы методом fetch, так как сервер иногда возвращает 503 ошибку:

const { inspect } = require('util');

var parents = null;
do {
  try {
	  parents = await user
		  .fetch("/webapi/userinfo/"+uchenikId+"/parents")
		  .then((res) => res.json());
  
  } catch (err) {
	  console.log(inspect(err, { showHidden: true }));
	  await new Promise(resolve => setTimeout(resolve, 10000));
  } 
} while (parents !== null);

Следующий код с методом reportFile не отлавливает ошибку, а скрипт просто без всяких сообщений прекращает работу с случае если сервер что-то не то ответил.

try {
  result = await user.reportFile({
	url: "reports/studenttotal/queue",
	filters: [
			{
		filterId: "PCLID",
		filterValue: klassid, // ID класса
			},
			{
		filterId: "SEPTYPE",
		filterValue: "0",
			},
			{
		filterId: "period",
		filterValue: period,
			},
	],
	timeout: 5000
});
} catch (err) {
  console.log(inspect(err, { showHidden: true }));
  result = null;
}

В консоли только отображается "DONE Сеанс [МОЙ ЛОГИН] успешно закрыт" после чего весь мой скрипт прекращает работу.
Я попробовал посмотреть в результате чего происходит внештатное завершение.
Иногда сервер возвращает:
{"R":{"Success":false,"Message":"Ошибка запуска задачи"},"I":"0"}
Но это не всё, бывает иногда и какая-то другая причина. В любом случае хотелось бы иметь возможность обработать ошибку, что бы сделать повторный запрос.

Error: Fetch failed при логине

Базовый код из доки не работает

Ожидаемое поведение
Хотелось бы авторизироваться.
image

image

Версия последняя, нода v18.17.1

Если смотреть через burp, то роут для авторизации другой
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.