API
We offer an API for the Smantry App that developers can use to create integrations with other applications and services.
Open source projects
The following open source projects have emerged around the Speisekammer.App API.
Ideas for future projects Examples of use
- Build a display using a custom monitor, smart mirror, or similar. The display can be used to show the current state of your pantry.
- Integration with smart home systems such as Home Assistant, OpenHAB, ioBroker, etc. to display the current status of your pantry.
General information
- Reading access is free.
- A premium membership is required for write access.
- We do not plan to introduce any incompatibilities in the further development of the API, but we cannot completely rule them out.
- The API is subject to change.
- How does authentication work?
- We use a bearer token approach. Generate a token and use it to access the API. The token expires after the desired period of time. You can generate a new token at any time. You must pass the token with each API request.
- The API token will only appear once and then disappear. For security reasons, we do not keep track of generated API tokens. Please make sure you copy it now. If you lose your token, you can generate a new one.
- You must be logged in with a verified email address to generate a token.
- The token identifies you as your user to the API and has all the same rights as your user, so be careful when changing or deleting content.
Example API call that retrieves all your communities using curl:
curl -X 'GET' 'https://api.speisekammer.app/communities' -H 'accept: application/json' -H 'Authorization: Bearer INSERT_YOUR_TOKEN_HERE'