API-Zugang (für Entwickler)

Einstellungen → Integrationen (/app/settings/integrations), Karte API-Zugang (für Entwickler) unten auf der Seite. Nur Inhaber und Administratoren. "Verbinden Sie OmniBrand mit Ihren eigenen Systemen, Zapier oder Make, um automatisch Beiträge zu erstellen, Kontakte hinzuzufügen oder Analysen abzurufen." Mit einem Schlüssel kann Ihre eigene Software die öffentliche API von OmniBrand mit dem Header Authorization: Bearer ob_live_… aufrufen. Unten auf der Karte zeigt API-Endpunkt die Adresse, an die diese Anfragen gehen ("Die Adresse, unter der die öffentliche API antwortet. Senden Sie jede Anfrage dorthin, mit einem der Schlüssel oben."). Ältere Links auf /app/settings#developer öffnen diese Karte.

Welche Tarife ihn enthalten

API-Zugang gehört zu den Tarifen Agency und Enterprise. In Free, Starter und Pro sowie während der 14-tägigen Pro-Testphase zeigt die Karte nur "API-Zugang ist im Tarif Agency enthalten." mit dem Link Tarife ansehen zu Tarif & Nutzung; es gibt kein Formular für Schlüssel. Die Tarifkarten unter Tarif & Nutzung und auf /pricing nennen API-Zugang für Agency und Enterprise.

Wenn sich der Tarif ändert

• Wechselt das Konto in einen Tarif ohne API-Zugang (ein Downgrade, eine Erstattung oder das Ende einer Testphase), werden seine Schlüssel pausiert: Sie bleiben gespeichert und nichts wird gelöscht, aber jeder Aufruf damit wird mit "API access is available on the Agency and Enterprise plans. Upgrade under Settings > Plan & usage to use API keys." abgelehnt (HTTP 403, Code api_access_not_in_plan).
• Der Kontoinhaber erhält eine einzige E-Mail, Your API keys are paused ("Ihre API-Schlüssel sind pausiert, weil Ihr Tarif keinen API-Zugang mehr enthält…"), mit der Schaltfläche Tarife ansehen.
• Der Wechsel zurück zu Agency oder Enterprise schaltet dieselben Schlüssel innerhalb einer Minute wieder ein. Neue Schlüssel sind nicht nötig.
• Während der Pause werden die Schlüssel nicht aufgelistet und lassen sich weder erstellen noch rotieren. Um einen Schlüssel endgültig zu stoppen, wechseln Sie wieder in einen Tarif mit API-Zugang und klicken Sie bei ihm auf Widerrufen, oder wenden Sie sich an den Support.

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

1. Geben Sie unter Schlüsselname einen Namen ein (zum Beispiel CI bot), bis zu 60 Zeichen, damit Sie später wissen, was ihn nutzt. Ohne Namen (oder nur mit Leerzeichen) erstellt Schlüssel erstellen nichts und das Feld sagt "Geben Sie dem Schlüssel einen Namen, zum Beispiel "Website-Sync"." Leerzeichen vor und nach dem Namen werden entfernt.
2. In Schlüssel-Berechtigungen wählen Sie nur lesen (Daten lesen) oder lesen + schreiben (auch Dinge erstellen und ändern).
3. Klicken Sie auf Schlüssel erstellen.
4. Ein gelbes Feld zeigt "Neuer Schlüssel für "(Name)". Kopieren Sie ihn jetzt: Er wird nur einmal angezeigt." und den vollständigen Schlüssel, mit Kopieren (danach steht dort Kopiert) und Ich habe ihn gesichert, womit das Feld geschlossen wird. Kopieren Sie den Schlüssel jetzt und bewahren Sie ihn an einem sicheren Ort auf; OmniBrand speichert nur einen Fingerabdruck und kann ihn nie wieder anzeigen.

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: fragt zuerst: „‚(Name)‘ (Präfix…) rotieren? Sie erhalten sofort einen neuen Schlüssel. Der aktuelle Schlüssel funktioniert noch 24 Stunden und hört dann auf; setzen Sie den neuen Schlüssel also vorher überall ein, wo der alte verwendet wird.“ Klicken Sie auf Schlüssel rotieren, um fortzufahren, oder auf Abbrechen. Der neue Schlüssel mit demselben Namen und demselben Umfang wird einmal im selben gelben Feld angezeigt. Der alte Schlüssel funktioniert noch 24 Stunden, damit Sie Ihre Integration umstellen können, und hört dann auf. Bis dahin bleibt er in der Liste, nicht durchgestrichen, mit „Alter Schlüssel funktioniert bis [Datum und Uhrzeit]“ und einer Schaltfläche Widerrufen.
• Widerrufen: fragt "Den Schlüssel (Name) (Präfix…) widerrufen? Alles, was ihn verwendet, funktioniert sofort nicht mehr, und ein widerrufener Schlüssel kann nicht wieder aktiviert werden." Das Fenster heißt Schlüssel widerrufen?; klicken Sie auf Schlüssel widerrufen, um den Schlüssel sofort zu stoppen, oder auf Abbrechen, um ihn zu behalten. 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 stoppt. Widerrufene Schlüssel (und rotierte Schlüssel nach Ablauf ihrer 24 Stunden) bleiben durchgestrichen in der Liste, mit einer roten Beschriftung "Widerrufen am (Datum)" unter dem Namen.

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

• "This API key has expired. Rotate it under Settings > Integrations > API access.": Schlüssel gelten ein Jahr. Klicken Sie unter API-Zugang (für Entwickler) 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.
• „Dieser Endpunkt steht API-Schlüsseln nicht zur Verfügung“: Dieser Aufruf ist nur für eine angemeldete Person möglich, unabhängig vom Umfang des Schlüssels. Ein Schlüssel kann niemals auf Folgendes zugreifen: Mitglieder und Einladungen (/workspaces/{id}/members, /workspaces/{id}/invitations, /invitations), das Erstellen, Umbenennen, Archivieren, Entarchivieren oder Löschen eines Arbeitsbereichs, ausgehende Webhooks (/workspaces/{id}/webhooks), Exporte, die Genehmigungskette, Berichtspläne, das Verbinden, Trennen oder Entfernen eines Kanals oder das Ändern seines Inhabers, Logo, Profil und Onboarding der Organisation sowie alles unter /auth, /billing, /admin oder /tenant/api-keys. Erledigen Sie dies in der App, angemeldet als Inhaber oder Admin. KI über einen Schlüssel umfasst Beitragstext, Ideen, Bilder, Umformulierungen, Hashtags, Alt-Text und die Einordnung von Nachrichten, bis zu 10 Aufrufe pro Minute und 300 pro Tag je Schlüssel ("API key AI rate limit exceeded"); Video, AI Studio und die übrigen KI-Helfer sind nur für angemeldete Personen. Market-Watch-Aufgaben, -Quellen und -Einstellungen, Bots und Workspace-Einstellungen wie die automatische Sichtung kann ebenfalls nur eine angemeldete Person ändern. Auch der Support ein- oder auszuschalten, seine KI-Klassifizierung zu ändern und die KI-Auswertung von Brand Health erfordern eine angemeldete Person, und ein mit einem Schlüssel angeforderter Bericht enthält nur dann eine KI-Zusammenfassung, wenn sie bereits vorhanden ist.

Verwandt

• Tarife
• Integrationen: ausgehende Webhooks
• Rollen und Berechtigungen
• Die Einstellungsseite