Entwickler-API-Schlüssel

Einstellungen, Abschnitt Entwickler-API-Schlüssel (/app/settings#developer). Nur für Inhaber und Administratoren. Ein Schlüssel ermöglicht es Ihrer eigenen Software, die OmniBrand-öffentliche API mit dem Header Authorization: Bearer ob_live_ aufzurufen...

Schritt für Schritt: Erstellen Sie einen Schlüssel

1. Geben Sie einen Namen in Schlüsselname (z. B. CI-Bot) ein, bis zu 60 Zeichen, damit Sie später wissen, was ihn verwendet.
2. Wählen Sie nur lesen (Daten lesen) oder lesen + schreiben (auch Dinge erstellen und verändern).
3. Klicken Sie auf Schlüssel erstellen.
4. Ein gelbes Feld zeigt "API-Schlüssel (jetzt kopieren – nur einmal angezeigt):" und den vollständigen Schlüssel. Kopieren Sie ihn jetzt und bewahren Sie ihn an einem sicheren Ort auf; OmniBrand speichert nur einen Fingerabdruck und kann ihn nie wieder zeigen.

Die Liste

Jeder Schlüssel zeigt seinen Namen, die ersten Zeichen (ob_live_...), seinen Umfang, wann er zuletzt verwendet wurde ("used ..." oder "nie verwendet") und "incires ..." mit seinem Enddatum. - Rotieren: erstellt einen neuen Schlüssel mit demselben Namen und Geltungsbereich und zeigt ihn einmal an. Der alte Schlüssel funktioniert noch 24 Stunden weiter, damit Sie Ihre Integration umstellen können, und hört dann auf. Bis dahin bleibt er nicht durchgestrichen in der Liste, mit "Alter Schlüssel funktioniert bis {Datum und Uhrzeit}" und einer Schaltfläche Widerrufen. - Widerrufen: stoppt den Schlüssel sofort. Das funktioniert auch bei einem alten Schlüssel während seiner 24 Stunden nach einer Rotation: Wenn Sie rotiert haben, weil der Schlüssel offengelegt wurde, klicken Sie beim alten Schlüssel auf Widerrufen, damit er sofort aufhört. Widerrufene Schlüssel (und rotierte Schlüssel nach Ablauf ihrer 24 Stunden) bleiben durchgestrichen in der Liste.

Wer besitzt einen Schlüssel

• Ein Schlüssel gehört der Person, die ihn erstellt hat, und deckt die Arbeitsbereiche ab, in denen diese Person zum Zeitpunkt der Erstellung Inhaber oder Administrator ist.
• Es funktioniert nur, solange der Ersteller noch aktiver Inhaber oder Administrator aller Arbeitsbereiche ist, die es abdeckt. Wenn sie entfernt, degradiert oder ihr Login deaktiviert wird, scheitern die Aufrufe mit "Die Person, die diesen API-Schlüssel erstellt hat, verwaltet seine Arbeitsbereiche nicht mehr. Bitte einen aktuellen Administrator, einen neuen Schlüssel auszustellen."
• Sie sehen, rotieren und widerrufen Sie nur die Schlüssel, deren Arbeitsbereiche Sie selbst verwalten. In einem Konto mit vielen Client-Arbeitsbereichen kann der Administrator eines Kunden die Schlüssel eines anderen Kunden nicht sehen.

Wenn etwas schiefgeht

• "Dieser API-Schlüssel ist abgelaufen. Erneuern Sie ihn unter Einstellungen > Entwickler-API-Schlüssel.": Schlüssel gelten ein Jahr. Klicken Sie unter Entwickler-API-Schlüssel bei dem Schlüssel auf Rotieren (oder erstellen Sie einen neuen) und aktualisieren Sie Ihre Integration.
• "Ungültiger oder widerrufener API-Schlüssel": Der Schlüssel wurde widerrufen, seine 24-Stunden-Rotations-Gnade endete oder er wurde unvollständig kopiert.
• Ein API-Schlüssel kann keine anderen Schlüssel erstellen, rotieren oder widerrufen; nur eine angemeldete Person kann das.

Verwandt

• Rollen und Berechtigungen
• Die Einstellungsseite