API Hilfe

Mit dieser API koennen einzelne Kreise per GET auf Standardfarben oder per POST mit Hex-Farbwerten gesetzt werden. Zusaetzlich kann der Hintergrund einzelner Felder per APT-Token angepasst werden.

Alle Zustände abfragen

GET /api/circles

Diese Anfrage liefert ein JSON mit allen Kreisen und ihren Hex-Farben, zum Beispiel A1, B3 oder F5.

Einen Kreis einschalten

GET /api/circles/A1/on

Der Kreis A1 wird auf die Standardfarbe Gruen gesetzt.

Einen Kreis ausschalten

GET /api/circles/A1/off

Der Kreis A1 wird auf die Standardfarbe Grau gesetzt.

Einen Kreis per POST faerben

POST /api/circles/A1

JSON-Body: {"color":"#ff0000"}

Damit wird die Farbe direkt ueber einen Hex-Wert gesetzt. Der POST-Body aendert keinen Status wie on oder off.

Feldhintergrund mit APT-Token aendern

POST /api/fields/A1/background

Header: X-APT-Token: <token>

JSON-Body: {"color":"#ffd166"}

Das Token wird auf der geschuetzten Seite /tokens erzeugt und ist immer genau an ein Feld wie A1 gebunden.

Wichtige Regeln

Erlaubte Spalten sind A bis F.
Erlaubte Reihen sind 1 bis 5.
Bei GET sind erlaubte Zustände nur on und off.
Bei POST muss color ein Hex-Wert wie #ff0000 sein.
Ein APT-Token darf nur den Hintergrund des zugewiesenen Feldes aendern.
Ein ungueltiger Kreis liefert Fehler 404.
Ein ungueltiger Status oder ungueltiger Hex-Wert liefern Fehler 400.