Update readme

This commit is contained in:
Fred Boniface 2022-12-01 13:51:01 +00:00
parent c76a3c561b
commit 3bd6153211
1 changed files with 15 additions and 5 deletions

View File

@ -6,10 +6,20 @@ Powered by Node.JS and using the ldbs-json module, the OwlBoard API provides up
Whilst the application is open source, the webservice (owlboard.fb-infra.uk) is not openly available. National Rail Enquiries have limits on API access so to use this software yourself, you'll need to run your own instance after obtaining your own API key.
## Default Settings
webPort: 8460
## WebApp Colours:
- To be updated
- To be updated
## API Endpoints:
- /api:
- /test:
- GET: Check your connection with the server
- POST: Check your auth key
- Request Body JSON: `{"auth":""}`
- Returns JSON: `{"auth":"true/false"}`
- /list:
- GET: Get list of stations
- Returns JSON: `{"STATION NAME":{"CRS":"code","TIPLOC":"code"}}`
- /ldb: