# studip-api

> This small package is not from the creators of Stud.IP. Instead it only offers limited functions for the Stud.IP API.

Latest version **1.0.12** (published 2023-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install studip-api
pnpm add studip-api
yarn add studip-api
bun add studip-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.12 |
| Published | 2023-01-18 |
| First published | 2021-09-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 48.9 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nils Baumgartner |
| Maintainers | fireboltcaster |
| Keywords | studip, api, auth, connect |

## Links

- npm: https://www.npmjs.com/package/studip-api
- Repository: https://github.com/FireboltCasters/studip-api
- Homepage: https://github.com/FireboltCasters/npm-template#readme
- Issues: https://github.com/FireboltCasters/npm-template/issues
- npm.io page: https://npm.io/package/studip-api

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) ^0.21.4
- [Base64](https://npm.io/package/Base64.md) ^1.1.0
- [buffer](https://npm.io/package/buffer.md) ^6.0.0
- [eslint](https://npm.io/package/eslint.md) ^7.32.0
- [base64-js](https://npm.io/package/base64-js.md) ^1.5.1
- [buffer-from](https://npm.io/package/buffer-from.md) ^1.1.2
- [@babel/preset-typescript](https://npm.io/package/@babel/preset-typescript.md) ^7.14.5
- [@stdlib/buffer-from-string](https://npm.io/package/@stdlib/buffer-from-string.md) ^0.0.8

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.0.12 (latest) — 2023-01-18
- 1.0.11 — 2023-01-18
- 1.0.10 — 2023-01-17
- 1.0.9 — 2022-08-02
- 1.0.8 — 2022-08-01
- 1.0.7 — 2022-08-01
- 1.0.6 — 2022-08-01
- 1.0.5 — 2022-07-31
- 1.0.4 — 2022-07-31
- 1.0.3 — 2021-09-29
- 1.0.2 — 2021-09-12
- 1.0.1 — 2021-09-12
- 0.0.6 — 2021-09-12
- 0.0.5 — 2021-09-12
- 0.0.4 — 2021-09-12
- … 2 more at https://npm.io/package/studip-api/versions

## README

<h2 align="center">
    studip-api
</h2>

<p align="center">
  <a href="https://badge.fury.io/js/studip-api.svg"><img src="https://badge.fury.io/js/studip-api.svg" alt="npm package" /></a>
  <a href="https://img.shields.io/github/license/FireboltCasters/studip-api"><img src="https://img.shields.io/github/license/FireboltCasters/studip-api" alt="MIT" /></a>
  <a href="https://img.shields.io/github/last-commit/FireboltCasters/studip-api?logo=git"><img src="https://img.shields.io/github/last-commit/FireboltCasters/studip-api?logo=git" alt="last commit" /></a>
  <a href="https://www.npmjs.com/package/studip-api"><img src="https://img.shields.io/npm/dm/studip-api.svg" alt="downloads week" /></a>
  <a href="https://www.npmjs.com/package/studip-api"><img src="https://img.shields.io/npm/dt/studip-api.svg" alt="downloads total" /></a>
  <a href="https://github.com/FireboltCasters/studip-api"><img src="https://shields.io/github/languages/code-size/FireboltCasters/studip-api" alt="size" /></a>
  <a href="https://github.com/google/gts" alt="Google TypeScript Style"><img src="https://img.shields.io/badge/code%20style-google-blueviolet.svg"/></a>
  <a href="https://shields.io/" alt="Google TypeScript Style"><img src="https://img.shields.io/badge/uses-TypeScript-blue.svg"/></a>
  <a href="https://github.com/marketplace/actions/lint-action"><img src="https://img.shields.io/badge/uses-Lint%20Action-blue.svg"/></a>
</p>


<p align="center">
  <a href="https://github.com/FireboltCasters/studip-api/actions/workflows/npmPublish.yml"><img src="https://github.com/FireboltCasters/studip-api/actions/workflows/npmPublish.yml/badge.svg" alt="Npm publish" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=alert_status" alt="Quality Gate" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=bugs" alt="Bugs" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=coverage" alt="Coverage" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=code_smells" alt="Code Smells" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=duplicated_lines_density" alt="Duplicated Lines (%)" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=sqale_rating" alt="Maintainability Rating" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=reliability_rating" alt="Reliability Rating" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=security_rating" alt="Security Rating" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=sqale_index" alt="Technical Debt" /></a>
  <a href="https://sonarcloud.io/dashboard?id=FireboltCasters_studip-api"><img src="https://sonarcloud.io/api/project_badges/measure?project=FireboltCasters_studip-api&metric=vulnerabilities" alt="Vulnerabilities" /></a>
</p>

## 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

```javascript
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

<a href="https://github.com/FireboltCasters/studip-api"><img src="https://contrib.rocks/image?repo=FireboltCasters/studip-api" alt="Contributors" /></a>

---
_Source: https://npm.io/package/studip-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._