📚 Documentation
Deprecated! ⚠
This project is no longer maintained! I have no desire and ability to follow changes in their API to support this module.
About
Mykoob API is a basic Node.js module that allows you to interact with the Mykoob very easily! This library wraps the Mykoob REST Api, which is used by Mykoob mobile app, so some features available only for the Mykoob Plus subscribers!
Installation
npm install mykoob-api --save
Features
- Authorization ( Access token receiving )
- Available APIs list receiving
- User data receiving
- User profile image receiving
- Activities receiving ( Feed )
- Lessons plan receiving
- Receiving number of unseen events
- Mark events as seen
- Receiving info about Mykoob Plus
- Attendance receiving ( Mykoob Plus Only )
- Homework receiving ( Mykoob Plus Only )
- Grades receiving ( Mykoob Plus Only )
Example
const MykoobAPI = require('mykoob-api');
const api = new MykoobAPI({
email: 'example@outlook.com',
password: 'qwerty123'
});
// Self-executing async function
(async () => {
// Authorization ( executed automatically, if not already authorized )
await api.authorize();
// Get list of available users on account
const usersList = await api.getUsers();
// Get user profile data
const userData = await api.userData();
// Get number of unseen events
const unseenEvents = await api.unseenEvents();
// Mark events as seen
const markStatus = await api.markAsSeen();
// Get profile image in base64
const profileImage = await api.userProfileImage('SMALL');
// Get lessons plan
const lessonPlan = await api.lessonsPlan({
from: Date.now() - 86400,
to: Date.now(),
school_classes_id: usersList[0].school_classes_id,
school_user_id: usersList[0].school_user_id,
});
// Get user activities
const userActivities = await api.userActivities({
from: Date.now() - 86400,
to: Date.now(),
});
})();This Wrapper supports only the basic functionality of Mykoob REST Api. I do not plan to add support for something more specific, like chats.