kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-23 15:19:35 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Traines 2024-12-07 23:48:17 +00:00
parent 0e328aa681
commit f5008fc747
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
readme.md
View file

@ -8,12 +8,19 @@
This is a very early version. What works: This is a very early version. What works:
* rudimentary `/journeys` including lowest prices * rudimentary `/journeys` including lowest prices
* `/locations`, `/locations/nearby`
* `/departures`, `/arrivals` (requires a DB API Key for RIS::Boards, maybe you find one somewhere ;)
What doesn't work (yet): What doesn't work (yet, see TODO's scattered around the code):
* `/journeys` details like scheduledDays, stop/station groups, tickets, some line details (see TODO's scattered around the code)... * `/journeys` details like scheduledDays, stop/station groups, tickets, some line details ...
* `/journeys` uses different tripIds compared to departure and arrival boards...
* certain stop details like products for `/locations` and geopositions for departures and arrivals
* some query options like BahnCards etc.
* all other endpoints * all other endpoints
Feel free report anything that you stumble upon via Issues or create a PR :)
Also consult the relevant **[documentation](https://github.com/public-transport/hafas-rest-api/docs/readme.md)** of [hafas-client](https://github.com/public-transport/hafas-client/) (but beware of the limited functionality of db-vendo-client). Also consult the relevant **[documentation](https://github.com/public-transport/hafas-rest-api/docs/readme.md)** of [hafas-client](https://github.com/public-transport/hafas-client/) (but beware of the limited functionality of db-vendo-client).
@ -29,6 +36,7 @@ See an example in [api.js](api.js). It shows how you can use `db-vendo-client` t
There are [community-maintained TypeScript typings available as `@types/hafas-client`](https://www.npmjs.com/package/@types/hafas-client). There are [community-maintained TypeScript typings available as `@types/hafas-client`](https://www.npmjs.com/package/@types/hafas-client).
For the `/departures` and `/arrivals` endpoints, `DB_API_KEY` and `DB_CLIENT_ID` environment variables for RIS::Boards have to be set.
## API ## API