Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dispherical/hctb-api
An API server for Here Comes the Bus
https://github.com/dispherical/hctb-api
Last synced: about 2 months ago
JSON representation
An API server for Here Comes the Bus
- Host: GitHub
- URL: https://github.com/dispherical/hctb-api
- Owner: dispherical
- License: agpl-3.0
- Created: 2022-11-30T00:46:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T01:29:55.000Z (10 months ago)
- Last Synced: 2024-10-27T13:48:51.633Z (3 months ago)
- Language: JavaScript
- Size: 45.9 KB
- Stars: 16
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# here comes the bus api
An unoffical API & Client for [Here Comes The Bus](https://herecomesthebus.com/)
## ui
To enable the UI, you can just append `ENABLE_UI=true`
```
ENABLE_UI=true yarn start
```
## home assistant
Expiremental Home Assistant support has been added as of 2.1.0. Ensure you have a `config.js` with all of the fields filled out and a running hctb-api server and run `node hass.js`
## known bugs
- Accounts with multiple passengers listed face issues. As a temporary workaround, try using `/api/passengers`, then calling `/api/session`. You'll need to provide the route time UUID yourself. [issue 2](https://github.com/aboutdavid/hctb-api/issues/2). Version 3 will overhaul the API entirely and should fix the issue.
## api
There is also an openapi.yaml file in the root directory.
POST `/api/passengers`
Usage: Getting all of the users for an account. Use this if you have multiple students under one account.
**Querystrings**
- user: Your HCTB email
- pass: Your HCTB password
- code: Your HCTB district code, it's usually a 5 digit code that is used by the district.
Example Response:
```json
{
"success": true,
"cookie": ".ASPXFORMSAUTH=...",
"passengers": [
{
"text": "David ",
"value": "7385b4fa-4563-4f02-97ea-0492e461924"
}
]
}
```
POST `/api/login`
Usage: Logins and grabs the location of the first student listed. This may fail if you have more than one student. See [issue 2](https://github.com/aboutdavid/hctb-api/issues/2) to learn more.
**Querystrings**
- user: Your HCTB email
- pass: Your HCTB password
- code: Your HCTB district code, it's usually a 5 digit code that is used by the district.
Example Response:
```json
{
"success": true,
"name": "David",
"person": "7385b4fa-4563-4f02-97ea-0492e4619248",
"time": "24b3a39b-8dc8-4cf5-a98c-d8ab9b05d544",
"lat": "33.7488",
"lon": "-84.3877",
"cookie": ".ASPXFORMSAUTH=...",
"times": [
{
"id": "00b19431-c745-42cd-bb43-c1fe83a19f0d",
"selected": true,
"time": "AM"
},
{
"id": "487f4d75-8e59-442a-9da4-a59424aecf1f",
"selected": false,
"time": "MID"
},
{
"id": "9e89abd0-781c-4a2a-875f-a794c029330d",
"selected": false,
"time": "PM"
}
]
}
```
POST `/api/session`
Usage: Preventing the need from logging in again until the cookie previously used expires.
**Querystrings**
- cookie: The cookie which you have gotten from /api/login
- person: The person UUID (from /api/login)
- time: The bus route time UUID (from /api/login)
- name: The person's name obtained from /api/loign
Example Response:
```json
{
"success": true,
"name": "David",
"person": "7385b4fa-4563-4f02-97ea-0492e4619248",
"time": "24b3a39b-8dc8-4cf5-a98c-d8ab9b05d544",
"lat": "33.7488",
"lon": "-84.3877",
"cookie": ".ASPXFORMSAUTH=...",
"times": [
{
"id": "00b19431-c745-42cd-bb43-c1fe83a19f0d",
"selected": true,
"time": "AM"
},
{
"id": "487f4d75-8e59-442a-9da4-a59424aecf1f",
"selected": false,
"time": "MID"
},
{
"id": "9e89abd0-781c-4a2a-875f-a794c029330d",
"selected": false,
"time": "PM"
}
]
}
```
## hosting:
[heroku](https://heroku.com/deploy?template=https://github.com/aboutdavid/hctb-api) | [glitch](https://glitch.com/edit/#!/import/git?url=https://github.com/aboutdavid/hctb-api.git)
### self-hosting
```bash
yarn install
yarn start
# or
npm install
npm start
```