studip-api
TypeScript icon, indicating that this package has built-in type declarations

1.0.12 • Public • Published

studip-api

npm package MIT last commit downloads week downloads total size

Npm publish Quality Gate Bugs Coverage Code Smells Duplicated Lines (%) Maintainability Rating Reliability Rating Security Rating Technical Debt Vulnerabilities

About

A library to calculate the critical path in an given precedence-diagram.

Demo

https://fireboltcasters.github.io/studip-api/

Installtion

npm install studip-api

About

This package should help to communicate with a specific Stud.IP instance by using its REST-API. Please not the disclaimer on the bottom. Please note, that oAuth is a better form for authentification but due to restrictions to obtain the specific secrets this is some sort of workaround.

A full documentation of the official Stud.IP instance can be found here: http://docs.studip.de/develop/Entwickler/RESTAPI

Installation

npm i studip-api

Usage example

import {Client} from 'studip-api';

async function userLogin() {
  const domain = 'https://<yourStudIP_Domain>.de';
  const username = '<username>';
  const password = '<password>';

  try {
    const client = await Connector.getClient(domain, username, password);

    // to get user informations
    const user = client.getUser();

    // to get the current schedule
    const schedule = await client.loadSchedule();
  } catch (err) {
    console.log('incorrect password or other error');
  }
}

Disclaimer

This project is not officialy associated in any form with the Stud.IP product and does not claims to be part of the development.

Contributors

The FireboltCasters

Contributors

Readme

Keywords

Package Sidebar

Install

npm i studip-api

Weekly Downloads

48

Version

1.0.12

License

MIT

Unpacked Size

50.1 kB

Total Files

29

Last publish

Collaborators

  • fireboltcaster