Create vertical life api

Dorian Zedler 2020-09-19 18:16:52 +00:00
commit 14476d542b

16
vertical-life-api.md Normal file

@ -0,0 +1,16 @@
This is some documentation for the new (sadly proprietary) vertical life api of the IFSC.
# Location
The VL API is located at [https://ifsc.results.info/api/v1/](https://ifsc.results.info/api/v1/)
# Authentication
- The VL API requires "authentication".
- To authenticate, the user has to pass an API-Key an HTTP-Header.
- The header is: ```x-auth-token``` and the key is ```cc7375f680648e7e6171e035e70351eb``` (probably this is not the only key, but it is the only one I know about)
- For easy use, a browser plugin can be used to inject the header automatically, [this one](https://addons.mozilla.org/en-US/firefox/addon/modify-header-value/) worked just fine for me on Firefox.
# Usage
## Get competition types ("leagues")
- Path: ```/```
- This will return all seasons with leagues and the current one
- Example: [https://ifsc.results.info/api/v1/](https://ifsc.results.info/api/v1/)