API-Einstellungen
  • 11 Apr 2023
  • 1 Minute zum Lesen

API-Einstellungen


Article Summary

Die API verfügt über eine Reihe von Konfigurationseinstellungen, die ihr Verhalten auf Website-Ebene steuern. Site-Administratoren können die allgemeinen API-Einstellungen für Ihre Site konfigurieren, indem sie zum Schnellzugriffsmenü API-Einstellungen für die > Entwicklungs>->API navigieren.

Nur Nutzer mit der Funktion totara/api:managesettings können API-Einstellungen auf Website-Ebene konfigurieren. Standardmäßig umfasst dies Site-Administratoren und Site-Manager. Nutzer von Mandanten können nur Änderungen auf Client-Ebene vornehmen.
Die folgende Tabelle beschreibt die API-Einstellungen, die auf Website-Ebene definiert werden können. Einige Einstellungen können auch auf der individuellen Client-Ebene konfiguriert werden.

Weitere Informationen zu Preislimits und der Komplexität von Abfragen finden Sie in der Entwicklerdokumentation.
EinstellungBeschreibungHinweise
Website-RatenlimitLegen Sie die maximalen Kosten für die Abfragekomplexität für alle Clients pro Minute fest. Der Standardwert ist 500.000.
Kunden-RatenlimitLegen Sie die maximalen Kosten für die Abfragekomplexität pro Minute für einen einzelnen Client fest.Sie können dieses Limit für einzelne Clients konfigurieren, indem Sie deren Einstellungen bearbeiten. Der Standardwert ist 250.000.
Maximale AbfragekomplexitätLegen Sie die maximal zulässige Komplexität für eine einzelne Abfrage fest.Der Standardwert ist 6.000.
Maximale AbfragetiefeLegen Sie die maximal zulässige Tiefe für eine einzelne Abfrage fest.Der Standardwert ist 15.
Standard-Token-AblaufDies legt fest, wie lange Tokens standardmäßig gültig sind, wenn neue API-Clients hinzugefügt werden. Verwenden Sie die beiden Dropdown-Menüs, um den Wert und die Zeiteinheit (z. B. Stunden, Tage, Wochen) festzulegen.Sie können den Ablauf des Tokens für jeden Client konfigurieren, indem Sie seine Einstellungen bearbeitenDie Standardzeit beträgt 24 Stunden.
Standard-FehlerantwortDiese Einstellung legt fest, wie viele Informationen in API-Antworten bereitgestellt werden, wenn Fehler auftreten. Wählen Sie eine der folgenden Optionen aus:
  • Keine: API-Antworten geben keine spezifischen Informationen über den Fehler zurück
  • Normal: API-Antworten geben spezifische Informationen darüber zurück, warum der Fehler aufgetreten ist
  • Entwickler: API-Antworten geben spezifische Informationen darüber zurück, warum der Fehler aufgetreten ist, einschließlich eines vollständigen Stack-Traces
Die Standardoption ist Normal.

© Copyright 2024 Totara Learning Solutions. All rights reserved.


War dieser Artikel hilfreich?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.