Ein nur lesender API-Schlüssel, Schritt für Schritt
Diese Seite richtet sich an Administratoren und Entwickler, die einem KI-Agenten über die REST-API Lesezugriff auf Inhalte geben.
Sie führt durch das Erstellen der engsten Zugangsdaten: ein persönlicher API-Schlüssel nur mit dem Geltungsbereich read, der einem
für den Agenten angelegten Konto gehört. Die vollständige Referenz ist Persönliche API-Schlüssel.
Inhalt
- Schritt 1: ein Konto für den Agenten
- Schritt 2: eine Rolle, die nur Leseschlüssel erlaubt
- Schritt 3: den Schlüssel erstellen
- Schritt 4: ihn testen
- Schritt 5: ihn an den Agenten übergeben
- Schritt 6: erneuern und widerrufen
Schritt 1: ein Konto für den Agenten
Legen Sie ein Benutzerkonto an, das nach dem Agenten und seiner Aufgabe benannt ist ("Berichtsagent"), in einer Benutzergruppe für
Agenten. Geben Sie der Gruppe eine Rolle mit content/read für genau die Inhalte, die der Agent lesen soll, wo möglich nach Teilbaum
oder Sektion beschränkt (Rollen und minimale Rechte).
Prüfen Sie, was er lesen kann:
./console exp:access:check --user=<agent login> --node=<a node it should read>
./console exp:access:check --user=<agent login> --node=<a node it should not read>Die erste Prüfung sollte mit ALLOWED enden, die zweite mit DENIED und der Einschränkung, die abgelehnt hat.
Schritt 2: eine Rolle, die nur Leseschlüssel erlaubt
In einer neuen Installation darf keine Rolle Schlüssel erstellen. Fügen Sie der Rolle des Agenten hinzu:
- Setup > Rollen und Richtlinien > die Rolle > Neue Richtlinie.
- Modul apikey, Funktion create.
- Einschränkung Scope: nur
read.
Ein Schlüssel erhält nie ein Recht, das sein Eigentümer nicht hat, und die Seite bietet nur die Geltungsbereiche an, die die Rechte des Eigentümers erlauben.
Schritt 3: den Schlüssel erstellen
- Melden Sie sich als das Konto des Agenten an und öffnen Sie Mein Konto > API-Zugang (
/apikey/list). - Benennen Sie ihn unter Neuen Schlüssel erstellen nach dem Ort seiner Verwendung ("Berichtsagent, wöchentlicher Lauf").
- Kreuzen Sie nur read an.
- Wählen Sie die kürzeste passende Laufzeit (standardmäßig 7, 30, 90 oder 365 Tage).
- Drücken Sie Schlüssel erstellen. Der Schlüssel
expk_...wird einmal angezeigt; kopieren Sie ihn direkt in Ihren Geheimnisspeicher.
Schritt 4: ihn testen
export EXP_API_KEY='expk_...'
curl -s -H "Authorization: Bearer $EXP_API_KEY" https://example.com/api/ezp/v1/content/node/2| Antwort | Bedeutung |
|---|---|
| 200 mit dem Inhalt | Der Schlüssel funktioniert, und der Eigentümer darf den Knoten lesen |
401 invalid_token | Kein Schlüssel, ein falscher oder widerrufener Schlüssel, ein deaktivierter Eigentümer oder der Schlüssel wurde in der Adresse statt im Header gesendet |
401 expired_token | Der Schlüssel hat sein Enddatum überschritten |
403 access_denied | Der Eigentümer darf diesen Inhalt nicht lesen |
403 insufficient_scope | Die Route braucht einen Geltungsbereich, der dem Schlüssel fehlt, zum Beispiel für das Anlegen |
429 rate_limited | Zu viele Anfragen in dieser Minute; warten Sie auf Retry-After |
Testen Sie auch, dass ein Schreibzugriff abgelehnt wird: Ein POST an /api/ezp/v2/content/node/create mit diesem Schlüssel muss
mit 403 insufficient_scope antworten.
Schritt 5: ihn an den Agenten übergeben
- Legen Sie den Schlüssel in den Geheimnisspeicher der Agentenplattform oder in eine Umgebungsvariable.
- Lassen Sie Ihren Code den Header hinzufügen; das Modell sieht den Schlüssel nie (Agenten und die REST-API).
- Tragen Sie Name, Eigentümer, Geltungsbereich und Enddatum des Schlüssels in Ihre Liste der Zugangsdaten von Agenten ein.
Schritt 6: erneuern und widerrufen
- Erneuern Sie vor dem Enddatum: Erstellen Sie einen zweiten Schlüssel mit demselben Geltungsbereich, stellen Sie den Agenten um, prüfen Sie, dass sich Zuletzt benutzt des neuen Schlüssels füllt, und widerrufen Sie dann den alten Schlüssel.
- Widerrufen Sie sofort, wenn jemand anderes den Schlüssel gesehen haben könnte (in einen Chat eingefügt, committet, in einem Log ausgegeben, einem Modell gezeigt) oder wenn der Agent außer Dienst geht.
- Administratoren sehen und widerrufen jeden Schlüssel unter Setup > oAuth-Verwaltung > API-Schlüssel. Jedes Erstellen, jeder
Widerruf, jede erste Verwendung und jede Ablehnung steht im Audit-Trail als
access.apikey.*.
Verwandte Seiten
- Zugangsdaten für Agenten
- Ein nur lesender Inhaltsbericht
- OAuth und API-Schlüssel
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.