Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.51 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.51 KB

dsbmobile.js

badge badge badge badge badge

A Javascript package for the dsbmobile API

Installation

$ npm install dsbmobile

Example

import Dsbmobile from "dsbmobile";

const dsb = new Dsbmobile("<id>", "<password>");

dsb.getTimetable().then((timetable) => {
    console.log(timetable.entries[0].newSubject);
});
English

Documentation

You can read the docs right here.

Contribute

Feel free to contribute on the Github repository.

Browser issues

The official dsbmobile API doesn't send a CORS header, which is required for Browser requests, due to security reasons.

However, there is a way to bypass it that is not a security tradeoff.

Use https://mydsb.johannespour.de (also on Github) as the baseURL instead.

You can use it like this like this:

new Dsbmobile({
    id: "<id>",
    password: "<password>",
    baseURL: "https://mydsb.johannespour.de",
    resourceBaseURL: "https://mydsb.johannespour.de/light",
});

After that, all requests will not be sent to the official Server, but to the mydsb.johannespour.de one, which will make a request for you to the resource and add a CORS header. It works as a proxy between you and the official dsbmobile servers.

If you are concerned about privacy and other things, you can check out the code and/or host the middleware yourself.

Incompatible plan

As I only know the layout of my local DSBmobile substitution plan, it is possible that your DSBmobile substitution plan may be incompatible with this package.

If that is the case, please leave a comment below issue #43, in which you describe the layout of your plan, so a solution can be worked out.

Since version v1.2.0 you can also define your own handler to parse your custom substitution plan.