Referenz für Drittanbieter-IntegrationenTigerTag Firebase Integration

So verbindet sich ein Client mit TigerTag

Jeder Client folgt denselben vier Schritten: die öffentliche Firebase-Konfiguration abrufen, sich als Nutzer anmelden, die Firestore-REST-API mit dem Token des Nutzers aufrufen und dieses Token aktuell halten.

1. 1

   Öffentliche Konfiguration abrufen

   Ein einziger GET liefert die Konfiguration des Firebase-Projekts. Der apiKey ist absichtlich öffentlich: Er identifiziert das Projekt, nicht den Aufrufer. Speichern Sie ihn zwischen; eine wöchentliche Aktualisierung genügt.

   01-firebase-config.md
2. 2

   Als Nutzer anmelden

   E-Mail und Passwort des Nutzers liefern eine UID, ein idToken für 1 Stunde und ein refreshToken. Google Sign-In benötigt einen Browser, daher verwenden Clients ohne Oberfläche ein Passwort.

   02-authentication.md
3. 3

   Firestore lesen und schreiben

   Senden Sie das idToken als Bearer-Token. Spulen liegen in users/{uid}/inventory, Racks in users/{uid}/racks; Gewichte sind Nettogramm, Datumsangaben Unix-Millisekunden.

   03-data-model.md
4. 4

   Token aktuell halten

   Erneuern Sie das idToken, bevor die Stunde abläuft, und ersetzen Sie beide gespeicherten Tokens. Bei permission-denied einmal erneuern und den Lesevorgang einmal wiederholen.

   idToken erneuern

GET  https://tigertag-cdn.web.app/__/firebase/init.json

POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={apiKey}
     { "email": "user@example.com", "password": "…", "returnSecureToken": true }

GET  https://firestore.googleapis.com/v1/projects/{projectId}/databases/(default)/documents/users/{uid}/inventory
     Authorization: Bearer {idToken}

In diesem Repository dokumentierte Integrationen

Jeder Leitfaden in docs/clients behandelt die Authentifizierung, die gelesenen oder geschriebenen Daten, die Feldzuordnung und den Code. Die folgenden Ausschnitte sind aus den Leitfäden übernommen.

{
  "domain": "tigertag",
  "name":   "TigerTag",
  "version": "0.1.0",
  "requirements": ["pyrebase4>=4.5.0"],
  "config_flow": true,
  "iot_class": "cloud_polling"
}

weight_available = max(0, measured_raw_weight - container_weight)

pip install -r requirements.txt
python tigertag_client.py

pip install -r requirements.txt
export TIGERTAG_EMAIL=you@example.com
export TIGERTAG_PASSWORD=yourpassword
export SPOOLMAN_URL=http://192.168.1.10:7912
export DRY_RUN=1                    # dry-run mode
python3 sync.py

users/{uid}/scales/{mac}          ← heartbeat, every 30 s
users/{uid}/inventory/{spoolId}   ← weight_available + last_update

Sie entwickeln für eine andere Plattform? Ein neuer Leitfaden gehört nach docs/clients, ein optionales lauffähiges Beispiel nach examples/. CONTRIBUTING.md

Das Konto des Nutzers, die Regeln des Nutzers

Es gibt keinen gemeinsamen Schlüssel zu schützen und kein Master-Token, das durchsickern könnte: Ein Client kann genau das tun, was sein Nutzer tun kann, und Firestore setzt das auf dem Server durch.

Ein öffentlicher Vertrag für Integratoren

Das Repository wird als öffentlicher Vertrag behandelt: Änderungen, die Clients betreffen, erscheinen in diesem Repository mit demselben Release, und das Changelog verzeichnet jede einzelne als Added, Changed, Deprecated, Removed, Fixed oder Security.

Stabilitätsgarantien im READMECHANGELOG.md

Referenzdokumentation

Die Kerndokumente, auf denen jede Integration aufbaut, in der Reihenfolge, in der ein Client sie braucht.

• 01-firebase-config.mdDer öffentliche Firebase-Konfigurationsendpunkt, wozu jedes Feld dient und wie lange er zwischengespeichert wird.
• 02-authentication.mdAnmeldung mit E-Mail und Passwort, Token-Erneuerung und das Wiederholungsmuster bei permission-denied.
• 03-data-model.mdJede Firestore-Collection und jedes Feld: Inventar, Racks, Freunde, Profile, Waagen.
• 04-friend-system.mdWie der Zugriff für Freunde funktioniert: öffentliche Codes, private Schlüssel, die beidseitige Verbindung.
• 05-rate-limiting.mdAbfrageintervalle, Abfragelimits, Überwachung und warum App Check nicht erzwungen wird.
• rules/firestore.rulesDie öffentliche Kopie der bereitgestellten Firestore Security Rules.

Teil des TigerTag-Ökosystems

Dieser Leitfaden behandelt das Cloud-Konto. Die Chips, die Apps und die SDKs haben eigene Repositorys.

Fragen