Giter VIP home page Giter VIP logo

bth-api's Introduction

Blekinge Tekniska Högskola (BTH) API for NodeJS

A fully async API written in ES6 for retrieval of most parts of BTH's student portal


npm badge

Setting up

Installing
npm install bth-api
Quickstart
const api = require('bth-api');

// Fetch course books, fetches the available course plans,
//  picks the latest one, downloads the PDF and exctracts
//  ISBN numbers, which it returns
const books = await api.fetchCourseBooks('MA1444');

console.print(books[0]);
> ISBN 978-91-47-05291-2

Note: For now, the API uses requires an auth parameter to authenticate. The key is received by signing in to the student portal at BTH's website and extracting the value for the cookie '.BTHAT'.

Documentation

API
  const api = require('bth-api');
  api.fetchUserInfo(auth);
  api.fetchScannedExams(auth);
  api.fetchScannedExams(examId, auth);
  api.fetchScannedExam(examId, auth);
  api.fetchExamRegistrations(auth);
  api.fetchCourseRegistrations(auth);
  api.fetchCoursePlans(courseId);
  api.fetchCoursePlan(courseId, revision, asText = false);
  api.fetchCourseBooks(courseId);
  api.fetchComingExams(from, to, courseId);
  api.fetchActiveCourses(auth);
  api.fetchAccessCards(auth);
  api.fetchCourseResults(auth, courseId, courseOccasion, courseCode);

Note: the documentation is not yet completed. The API is still subject to change.

Contributing

Any contribution is welcome. If you're not able to code it yourself, perhaps someone else is - so post an issue if there's anything on your mind.

Development

Clone the repository:

git clone https://github.com/AlexGustafsson/bth-api.git && cd bth-api

Set up for development:

npm install

Follow the conventions enforced:

npm test

Disclaimer

Although the project is very capable, it is not built with production in mind. Therefore there might be complications when trying to use the API for large-scale projects meant for the public. The API was created to easily fetch student related information from BTH's services programmatically and as such it might not promote best practices nor be performant. This project is not in any way affiliated with Blekinge Tekniska Högskola (BTH).

bth-api's People

Contributors

alexgustafsson avatar

Watchers

 avatar  avatar

bth-api's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.