Docs/docs/community/public/index.md

30 lines
914 B
Markdown
Raw Permalink Normal View History

2024-05-12 15:58:27 +03:00
# Public instance
2024-05-14 00:40:45 +03:00
2024-05-26 15:27:12 +03:00
There is a publicly available hosted version of the API and all clients.
## When to use public instance
You should use public instance if:
* You need garbage reminders for [Gemeinde Schmitten](https://www.schmitten.de){:target="_blank"}
* You need a stable bot and API versions with good uptime
* You want to contribute [locations](locations.md) and/or [entries](entries.md)
* You need community and developer [support](report.md)
You should **NOT** use public instance if:
* You want to modify the source code
* You have non-standard garbage types
* You want to add non-standardized locations
## Start using it
### API
* Endpoint: <https://api.garbagebot.eu>{:target="_blank"}
* Docs: [Swagger](https://api.garbagebot.eu/docs){:target="_blank"} / [Redoc](https://api.garbagebot.eu/redoc){:target="_blank"}
### Telegram Bot
* Link: <https://t.me/GarbageReminder_Bot>{:target="_blank"}