API Docs

Die wichtigsten Befehle stehen hier zuerst. Zuerst kommen die Circle-GETs und das direkte Setzen der Kreisfarbe per PUT, danach die Hintergrundfarbe eines Feldes. Alles Weitere steht weiter unten dezenter zusammengefasst.

1. Alle Kreise lesen

GET /api/circles

Liefert alle Kreisfarben und alle Feldhintergruende als JSON zurueck.

2. Kreis auf on setzen

GET /api/circles/A1/on

Setzt einen Kreis wie A1 auf die gruene Standardfarbe.

3. Kreis auf off setzen

GET /api/circles/A1/off

Setzt einen Kreis wie A1 auf die graue Standardfarbe.

4. Kreisfarbe direkt setzen

PUT /api/circles/A1

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

Setzt die Kreisfarbe direkt ueber einen Hex-Wert.

Alternativ ist auch POST /api/circles/A1 mit demselben JSON-Body moeglich.

5. Hintergrundfarbe eines Feldes setzen

POST /api/fields/A1/background

Header: X-APT-Token: <token>

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

Setzt den Hintergrund des Feldes A1. Das Token bekommst du auf der geschuetzten Seite /tokens.

Wichtig: Ein APT-Token gilt immer nur fuer genau ein Feld, zum Beispiel nur fuer A1.

Weitere Befehle

APT-Token erzeugen

Auf /tokens waehlt ein authentifizierter Nutzer aus @bs7-augsburg.de per Dropdown ein Feld von A1 bis F5 aus und erhaelt dafuer einen Token.

Wichtige Regeln
  • Erlaubte Spalten sind A bis F.
  • Erlaubte Reihen sind 1 bis 5.
  • Bei GET sind erlaubte Zustaende nur on und off.
  • Bei Farbwerten sind nur Hex-Werte wie #ff0000 erlaubt.
  • Ein ungueltiger Kreis liefert 404.
  • Ein ungueltiger Status oder ungueltiger Hex-Wert liefern 400.