Zum Inhalt springen
Speisekammer Wissenslabor

API

Wir bieten für die Speisekammer.App eine API an, mit der Entwickler Integrationen in andere Anwendungen und Dienste erstellen können.

Open Source Projekte

Folgende Open Source Projekte sind um die Speisekammer.App API entstanden.

Scan Station auf Basis Node Red NodeRed Flow um eine Scan Station zu bauen, von unserem Community Mitglied Raik. Enthält spannende Erweiterungen wie Sets und Gruppen.
Minimalistisches Python Script zum Scannen Python Script für den Raspberry PI mit den Grundfunktionen.

Ideen für zukünftige Projekte Beispiele für die Verwendung

  • Baue ein Display mit einem benutzerdefinierten Monitor, Smart Mirror oder ähnlichem. Die Anzeige kann verwendet werden, um den aktuellen Zustand deiner Vorratskammer anzuzeigen.
  • Integration mit Smart-Home-Systemen wie Home Assistant, OpenHAB, ioBroker, etc. zur Anzeige des aktuellen Zustands deiner Speisekammer.

Allgemeine Hinweise

  • Der Lesezugriff ist kostenlos.
  • Für den Schreibzugriff ist eine Premium-Mitgliedschaft erforderlich.
  • Wir planen bei der Weiterentwicklung der API keine Inkompatibilitäten, können diese aber nicht vollständig ausschließen.
  • Änderungen an der API sind vorbehalten.
  • Wie funktioniert die Authentifizierung?
  • Wir verwenden einen Bearer-Token-Ansatz. Generiere ein Token und verwende ihn für den Zugriff auf die API. Das Token läuft nach der gewünschten Zeitspanne ab. Du kannst jederzeit ein neues Token generieren. Du musst das Token mit jeder API-Anfrage übergeben.
  • Das API-Token wird nur einmal angezeigt und verschwindet dann. Wir führen aus Sicherheitsgründen keine Aufzeichnungen über generierte API-Tokens. Bitte stelle sicher, dass du es jetzt kopierst. Wenn du dein Token verlierst, kannst du dir ein neues generieren.
  • Du musst mit einer verifizierten E-Mail-Adresse angemeldet sein, um einen Token zu generieren.
  • Der Token identifiziert dich gegenüber der API als dein Nutzer und hat auch alle Rechte wie dein Nutzer, sei also vorsichtig beim Ändern oder Löschen von Inhalten.

Beispiel API-Aufruf, der all deine Gemeinschaften abruft, mit curl:

curl -X 'GET' 'https://api.speisekammer.app/communities' -H 'accept: application/json' -H 'Authorization: Bearer INSERT_YOUR_TOKEN_HERE'