Technical description
The projects purpose is gather information about status of all the clubrooms (Open, Close, Unknown), and present them in a human-readable format, on a selected Telegram channel, but also as an Open API (we reserve the right to introduce rate-limiting in case of abuses). It is made so that everyone can integrate the clubroom status into their app / software, let it be a simple LED light which indicated if the clubroom is open, or the sophisticated mobile app.
Available commands are:
| # | URL | Description | Authentication required |
|---|---|---|---|
| 1 | /space/{space_name}/space.json | Get information on space (described with name) in json format | No |
| 2 | /space_events/{space_id}/open | Mark space (described with numerical id) as open | Yes |
| 3 | /space_events/{space_id}/close | Mark space (described with numerical id) as close | Yes |
Authentication is basic HTTP one, with credentials provided by Modeemi.
Basic examples provided in cURL:
| # | Command | Description |
|---|---|---|
| 1 | curl -X GET https://www.doors.modeemi.fi/space/{space_name}/space.json | Get information on space (described with name) in json format |
| 2 | curl -X POST https://www.doors.modeemi.fi/space_events/{space_id}/open --user "{login}:{pass}" | Mark space (described with numerical id) as open |
| 3 | curl -X POST https://www.doors.modeemi.fi/space_events/{space_id}/close --user "{login}:{pass}" | Mark space (described with numerical id) as closed |
Authentication is basic HTTP one, with credentials provided by Modeemi.