<aside> <img src="/icons/light-bulb_red.svg" alt="/icons/light-bulb_red.svg" width="40px" /> Willkommen im Lumi Labs-API-Referenzhandbuch! Diese umfassende Ressource bietet dir die Werkzeuge und Informationen, die du für eine nahtlose Integration in unser intelligentes Beleuchtungsökosystem benötigst. Dieser Leitfaden behandelt API-Endpunkte, Anfrage-/Antwortformate, Authentifizierungsmechanismen, Fehlerbehandlung und bewährte Praktiken, damit du das volle Potenzial von Lumi Labs ausschöpfen kannst.

</aside>

Erste Schritte

1. Erhalte den API-Schlüssel:

   • Um die Lumi Labs-API nutzen zu können, benötigst du einen API-Schlüssel. Registriere dich für ein kostenloses Developer-Konto auf unserem Developer-Portal und erstelle einen API-Schlüssel.

2. Authentifizierung:

   • Die Lumi Labs-API verwendet eine Bearer Token-Authentifizierung. Füge deinen API-Schlüssel in den Autorisierungs-Header aller Anfragen ein und verwende dabei das folgende Format:

   „Autorisierung: Bearer YOUR_API_KEY“.

3. Basis-URL:

   • Alle API-Anfragen sollten an die folgende Basis-URL gesendet werden:

   https://api.lumilabs.com/v1

API-Endpunkte

• Lichter
  • GET /lights: Abrufen einer Liste aller registrierten Leuchten.
  • GET /lights/{lightId}: Abrufen von Informationen über eine bestimmte Leuchte.
  • ENTER /lights/{lightId}/Status: Aktualisieren des Status einer Leuchte (ein/aus, Helligkeit, Farbe, etc.).
    • Anfragetext:
• POST /lights/{lightId}/effects: Anwendung eines Lichteffekts auf eine bestimmte Leuchte (z. B. pulsierend, stroboskopisch).

JSON

{ "on": true, "brightness": 50, "color": { "hue": 240, "saturation": 80, "brightness": 100 } }

Verwende diesen Code mit Vorsicht.

• Gruppen
  • GET /groups: Erhalte eine Liste aller Gruppen von Leuchten.
  • GET /groups/{groupId}: Erhalte Informationen über eine bestimmte Gruppe.
  • POST /groups: Erstelle eine neue Gruppe.
  • PUT /groups/{groupId}: Aktualisiere eine Gruppe.
  • DELETE /groups/{groupId}: Lösche eine Gruppe.
  • PUT /groups/{groupId}/action: Aktualisiere den Status aller Leuchten in einer Gruppe.
• Szenen
  • GET /scenes: Erhalte eine Liste aller erstellten Szenen.
  • GET /scenes/{sceneId}: Erhalte Informationen über eine bestimmte Szene.
  • POST /scenes: Erstelle eine neue Szene.
  • PUT /scenes/{sceneId}: Aktualisiere eine Szene.
  • DELETE /scenes/{sceneId}: Lösche eine Szene.
  • POST /scenes/{sceneId}/activate: Aktiviere eine Szene.
• Energieverbrauch
  • GET /lights/{lightId}/energy: Erhalte die Statistik zum Energieverbrauch einer bestimmten Leuchte.
  • GET /groups/{groupId}/energy: Erhalte die Statistik zum Energieverbrauch einer Gruppe von Leuchten.

Fehlerbehebung

Die Lumi Labs-API verwendet standardmäßige HTTP-Statuscodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen. Hier sind einige gängige Fehlercodes:

• 400 Bad Request: Die Anfrage ist fehlerhaft oder es fehlen erforderliche Parameter.
• 401 Unauthorized: Der API-Schlüssel ist ungültig oder fehlt.
• 403 Forbidden: Dir fehlt die Berechtigung, die angeforderte Aktion durchzuführen.
• 404 Not Found: Die angeforderte Ressource konnte nicht gefunden werden.