Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,110 of 9,110 pages
About the help in other languages
All help pages

OAuth und API-Schlüssel

Die richtigen Zugangsdaten für Programme wählen und verwenden, die Exponential aufrufen - OAuth2-Clients und die Richtlinie authorize, persönliche API-Schlüssel mit Scopes, expservices-Tokens, HTTP Basic, Laufzeiten…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/creators/app-creators/oauth-and-api-keys.md

On this page

This page is a translation. Read the English original

OAuth und API-Schlüssel

Diese Seite richtet sich an Anwendungsentwickler, die Programme mit Exponential verbinden. Es gibt drei Arten von Zugangsdaten; wählen Sie danach, für wen das Programm handelt.

Inhalt

  1. Welche Zugangsdaten
  2. OAuth2 für Anwendungen von Drittanbietern
  3. Persönliche API-Schlüssel
  4. expservices-Tokens
  5. Gute Praxis

Welche Zugangsdaten

Das ProgrammVerwendenLesen
handelt für viele Benutzer, die sich selbst anmelden (eine mobile App)OAuth23.1 OAuth2-Tokens
ist das eigene Skript eines einzelnen Benutzersein persönlicher API-SchlüsselPersönliche API-Schlüssel
steuert Dienste der Administration (Apps, Portale, Shells)ein expservices-TokenEntfernte Dienste und Apps

OAuth2 für Anwendungen von Drittanbietern

  1. Ein Administrator registriert den Client unter Setup > oAuth-Verwaltung (/oauthadmin/list): Kennung, Geheimnis, Weiterleitungsadresse.
  2. Die App schickt den Benutzer zu /oauth/authorize?client_id=...&redirect_uri=...&response_type=code&state=..., mit PKCE zusätzlich code_challenge=...&code_challenge_method=S256; der Benutzer meldet sich an und erlaubt den Zugriff, und die Website leitet mit dem Code und demselben state zurück. Der Benutzer braucht die Richtlinie oauth/authorize (optional nach Siteaccess eingeschränkt); ohne sie leitet die Website mit error=access_denied weiter (Richtlinie OAuth authorize).
  3. Die App tauscht den Code bei POST /api/auth/v1/oauth/token ein (grant_type=authorization_code, dazu code_verifier, wenn sie eine Challenge gesendet hat).
  4. Sie sendet Authorization: OAuth <token> (ein Token in der Adresse, ?oauth_token=, wird abgelehnt, außer bei rest.ini [OAuthSettings] AllowTokenInQuery=enabled); nach TokenTTL (standardmäßig eine Stunde) verwendet sie grant_type=refresh_token. Ein Refresh-Token gilt RefreshTokenTTL (standardmäßig 30 Tage) ab der Erneuerung, die es ausgestellt hat (Härtung der OAuth-Tokens).
oAuth-Verwaltung: die OAuth-Clients der Installation und ihr Zugriff
oAuth-Verwaltung: die OAuth-Clients der Installation und ihr Zugriff

Das Client-Geheimnis gehört auf einen Server. Eine App, die kein Geheimnis bewahren kann (eine mobile oder Browser-App), ist ein öffentlicher Client: Sie wird ohne Geheimnis gespeichert, sendet keines und muss PKCE mit S256 verwenden (PKCE und state). Eine Seite in einem Browser auf einem anderen Host erreicht die API nur, wenn CORS für ihren Ursprung eingeschaltet ist (CORS für die REST-API; standardmäßig aus).

Persönliche API-Schlüssel

  • Ein Benutzer mit apikey/create erstellt Schlüssel unter Mein Konto > API-Zugang (/apikey/list), mit Scopes und einer Laufzeit; der Schlüssel expk_... wird einmal angezeigt.
  • Anfragen mit Authorization: Bearer expk_... laufen als der Eigentümer, beschränkt auf die Scopes des Schlüssels und niemals über die Richtlinien des Eigentümers hinaus.
  • Gespeichert wird nur ein gesalzener HMAC des Geheimnisses. Schlüssel enden, wenn sie widerrufen werden, ablaufen oder wenn der Eigentümer deaktiviert wird.
  • Administratoren sehen und widerrufen jeden Schlüssel unter Setup > oAuth-Verwaltung > API-Schlüssel; jedes Erstellen, Widerrufen, die erste Verwendung und jede Ablehnung steht als access.apikey.* im Audit-Protokoll.

expservices-Tokens

expservices hat für seine Dienste eigene persönliche Tokens, die je Benutzer erstellt werden; die Anleitung zeigt Schritt für Schritt, wie Sie eines erstellen und Dienste aus der Shell und aus Python aufrufen (Entfernte Dienste und Apps).

Gute Praxis

  • Ein Satz Zugangsdaten je Programm, damit sich jeder einzeln widerrufen lässt.
  • Der kleinste Scope und die kleinste Rolle, die funktionieren; ein eigener Benutzer für Integrationen, nicht der Administrator.
  • Geheimnisse in Umgebungsvariablen oder einem Geheimnisspeicher; niemals in einem Repository, einer URL oder einem Log.
  • Kurze Laufzeiten, regelmäßiger Wechsel und ein Blick ins Audit-Protokoll auf Ablehnungen.

Verwandte Seiten

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.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x