1.0.0 • Published 4 years ago

mykoob-sdk v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

MyKoob SDK

Простой модуль для работы с MyKoob API

Установка

$ npm i mykoob-sdk

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

Для начала использования, вам нужно создать в своей папке исполняемый файл, пусть это будет index.js

Теперь его нужно открыть и импортировать библиотеку:

const MyKoobApi = require('mykoob-sdk')
const client = new MyKoobApi({
    username: "", // Здесь указывается твоя электронная почта
    password: "" // Здесь указывается пароль 
})

Доступные методы

getAuth

Отправляет запрос на получение авторизационного токена

async function run() {
    await client.api.getAuth().then((response) => {
        console.log(response)
    })
}

run().catch(console.error);

getMyData

Получение информации о всех пользователях подключенного аккаунта

async function run() {
    await client.api.getMyData().then((response) => {
        console.log(response)
    })
}
run().catch(console.error);

getUnseenEvents

Получить кол-во непрочитанных уведомлений

async function run() {
    await client.api.getUnseenEvents().then((response) => {
        console.log(response)
    })
}
run().catch(console.error);

markAllSeen

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

async function run() {
    await client.api.markAllSeen().then((response) => {
        console.log(response)
    })
}
run().catch(console.error);

getLessonsPlan

Получить расписание

async function run() {
    const userData = await client.api.getMyData()
    await client.api.getLessonsPlan({
        from: Date.now() - 84600,
        to: Date.now(),
        classId: userData[0].class.id,
        userId: userData[0].class.studentId
    }).then((response) => {
        console.log(response)
    })
}
run().catch(console.error);
ПараметрТипОписание
fromNumberНачальная временная позиция
toNumberКонечная временная позиция
classIdNumberУникальный идентификатор класса
userIdNumberУникальный идентификатор ученика в этом классе

getUserActivities

Получить активность текущего аккаунта

async function run() {
    await client.api.getUserActivities({
        from: Date.now() - 84600,
        to: Date.now()
    }).then((response) => {
        console.log(response)
    })
}
run().catch(console.error);
ПараметрТипОписание
fromNumberНачальная временная позиция
toNumberКонечная временная позиция