Early AccessNur auf Einladung, und die SDKs sind noch nicht veröffentlicht.Einladung anfragen
Zum Inhalt springen
Docs

Schlüssel

Ingest-Schlüssel können nur schreiben und sind absichtlich öffentlich; Server-, Lese- und Admin-Schlüssel bleiben auf einem Server.

Ein Schlüssel (key) gehört zu einem Projekt und hat einen von vier Geltungsbereichen. Sein Präfix verrät, welchen.

GeltungsbereichPräfixName im DashboardWas er kannWo er hingehört
Ingestlyr_ing_Send eventsEvents anhängen, sonst nichtsIn deine App oder deine Webseite
Serverlyr_srv_Send events from a serverEvents anhängen, sonst nichts. Seine Events sind verifiziert.Nur in dein Backend. Halte ihn geheim.
Lesenlyr_read_Read eventsEvents abfragenAuf einen Server oder in ein Skript. Halte ihn geheim.
Adminlyr_adm_Full accessEvents senden und abfragen, für VerwaltungsaufgabenAuf einen Server. Halte ihn geheim.

Ein Lese-Schlüssel fragt die Events seines Projekts über die Read API ab: aus einem Skript, einem Notebook oder einem Agenten auf einem Server. Er liest alles, was das Projekt enthält, und kommt deshalb nie in eine App oder eine Webseite.

Ein Server-Schlüssel sendet Events aus deinem Backend: aus dem Node-, Python-, Go- oder JVM-SDK oder mit curl. Wie ein Ingest-Schlüssel kann er nicht lesen, aber er ist geheim: Die Events, die er sendet, gelten als verifiziert, weil nur deine Server ihn haben, und der Tagesanteil einer einzelnen Absenderadresse gilt für ihn nicht. Er kommt nie in eine App oder eine Webseite. Apps und Webseiten verwenden den Ingest-Schlüssel.

Warum ein Ingest-Schlüssel öffentlich sein darf

Ein Ingest-Schlüssel steckt im Binary deiner App oder in deiner Webseite, also geh davon aus, dass ihn jeder lesen kann. Das ist in Ordnung, denn er kann nur Events an sein Projekt anhängen: Er kann nichts lesen, ändern oder löschen. Das Projekt, in dem ein Event landet, ergibt sich immer aus dem Schlüssel, nie aus dem Event. Gegen Missbrauch hat jedes Projekt ein Ratenlimit (standardmäßig 60.000 Events pro Minute), und ein Batch über dem Limit bekommt 429. Außerdem darf eine einzelne Adresse damit nur einen Tagesanteil des Monats der Organisation senden.

Die Kehrseite: Wer den Ingest-Schlüssel hat, kann Events senden, die wie die deiner App aussehen. Deshalb sind sie nicht verifiziert, es sei denn, sie kommen von deiner Apple-App und Apple bestätigt das mit App Attest, oder von deiner Android-App und das Smartphone bestätigt es mit Key Attestation. Solche Events zählen auch nicht zum Tagesanteil.

Schlüssel werden einmal angezeigt

Lyrelog speichert von jedem Schlüssel nur einen SHA-256-Hash. Du siehst den Schlüssel einmal, beim Erstellen: Kopiere ihn dann. Verlorene Schlüssel lassen sich nicht wiederherstellen; erstelle einen neuen.

Erstellen und widerrufen

Schlüssel liegen auf der Seite API keys des Projekts: Settings, dann API keys, oder ⌘ K und API keys. Nur Inhaber können sie erstellen und widerrufen.

  • Ein Projekt hat höchstens 20 aktive Schlüssel. Widerrufe einen, um einen weiteren zu erstellen.
  • Schlüssel laufen nicht ab: Ein Schlüssel funktioniert, bis er widerrufen oder sein Projekt gelöscht wird.
  • Für einen Schlüssel vom Typ Send events from a server, Read events oder Full access musst du dich kürzlich angemeldet haben (innerhalb der letzten 10 Minuten). Für Send events nicht.
  • Verlässt jemand eine Organisation oder wird entfernt, werden die Lese- und Full-Access-Schlüssel widerrufen, die diese Person erstellt hat. Ingest-Schlüssel bleiben, weil bereits ausgelieferte Apps damit senden. Server-Schlüssel bleiben ebenfalls, weil deine Server damit senden: Hat die Person, die gegangen ist, einen davon gesehen, widerrufe und ersetze ihn.
  • Alle in der Organisation sehen die Liste der Schlüssel und wann jeder zuletzt benutzt wurde.

Ein widerrufener Schlüssel funktioniert sofort nicht mehr; rechne mit bis zu einer Minute. Ein SDK, das 401 oder 403 bekommt, sendet nicht mehr, bis die App neu startet, und behält seine Events in der Warteschlange.