Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Magister.js

Travis CI Badge


Gitter npm version Known Vulnerabilities CodeFactor

A JavaScript implementation of the Magister 6 API.

Accreditation

The vendor of Magister, Iddink Digital, requires that all users of the API are accredited parties: this means that the company wants to check that you conform to their guidelines regarding security and personal data management. After registration with Iddink Digital, you will receive an authentication code (authcode) which is required by MagisterJS. For registration, send an email to: partners@iddinkgroup.com.

Quickstart

npm install magister.js

const { default: magister, getSchools } = require('magister.js');
// or with es6 modules:
// import magister, { getSchools } from 'magister.js'

// replace every '<thing>' with your credentials:

getSchools('<schoolname>') // get schools matching '<schoolname>'
	.then((schools) => schools[0]) // get the first school
	.then((school) => magister({ // login
		school,
		username: '<username>',
		password: '<password>',
	}))
	.then((m) => { // done logging in, say hi
		console.log(`Hey ${m.profileInfo.firstName}!`);
	}, (err) => { // something went wrong
		console.error('something went wrong:', err);
	});

Useful links

Before creating issues

  1. Update all dependencies with npm update
  2. Be sure you haven't made a typo and your code is correct (check the docs)
  3. Don't create issues which occur in a modified version

Contributing

  • Document your code using jsdoc
  • Respect and follow the current programming style
  • Test your changes with npm run test
  • Check your code style with npm run lint
  • Make sure that your code compiles with babel using npm run build
  • Only commit the src/ and test/ directory

License

LGPLv3