2.0.2 • Published 3 years ago

classeviva-apiv2 v2.0.2

Weekly downloads
7
License
MIT
Repository
github
Last release
3 years ago

Classe Viva API (v2)

GitHub license

You can use this api to access your data on the Classe Viva's electronic register.
This is an unofficial api, and it is inspired on another github repository.

(Link)

Installation

npm i classeviva-apiv2 --save

Usage

Importing

const ClasseViva = require("classeviva-apiv2").ClasseViva;

or

const { ClasseViva } = require("classeviva-apiv2");

Create session

ClasseViva.establishSession("username", "password").then(async session => {
  ...
});

Get profile informations

const profile = await session.getProfile();

Get student notes

const notes = await session.getNotes();

Get student marks

const marks = await session.getMarks();

Get today's topics

const topics = await session.getToday();
You can even specify a date
const topics = await session.getToday(date);

Get all assignments

const assignments = await session.getAssignments();