API-inställningar

API har ett antal konfigurationsinställningar som kontrollerar dess beteende på platsnivå. Webbplatsadministratörer kan konfigurera de allmänna API-inställningarna för din webbplats genom att navigera till snabbåtkomstmenyn > Utveckling > API > API-inställningar .

Endast användare med totara/api:managesettings rättighet kan konfigurera API-inställningar på platsnivå. Som standard inkluderar detta platsadministratörer och platschefer. Innehavaranvändare begränsas till att göra ändringar på klientnivå .

Tabellen nedan beskriver de API-inställningar som kan definieras på platsnivå. Vissa inställningar kan också konfigureras på individuell klientnivå .

För mer information om hastighetsgränser och frågekomplexitet, se utvecklardokumentationen .

Inställning	Beskrivning	Anteckningar
Gräns för platspris	Ställ in den maximala kostnaden för frågekomplexitet för alla kunder per minut.	Standardvärdet är 500 000.
Gräns för klientpris	Ställ in den maximala kostnaden för frågekomplexitet per minut för en enskild klient.	Du kan konfigurera denna gräns för enskilda klienter genom att redigera deras inställningar . Standardvärdet är 250 000.
Maximal komplexitet i fråga	Ställ in den maximala komplexitet som tillåts för en enda fråga.	Standardvärdet är 6 000.
Maximalt frågedjup	Ställ in maximalt tillåtet djup för en enda fråga.	Standardvärdet är 15.
Standardutgång för token	Detta ställer in standardlängden för tidstokens som kommer att vara giltiga när nya API-klienter läggs till. Använd de två rullgardinsmenyerna för att ställa in värde och tidsenhet (t.ex. timmar, dagar, veckor).	Du kan konfigurera utgångsdatumet för token för varje klient genom att redigera deras inställningar . Standardtiden är 24 timmar.
Standardsvar för fel	Denna inställning avgör hur mycket information som kommer att tillhandahållas i API-svar när fel uppstår. Välj ett av följande alternativ: Ingen: API-svar kommer inte att ge någon specifik information om felet Normal: API-svar kommer att ge specifik information om varför felet uppstod Utvecklare: API-svar kommer att ge specifik information om varför felet uppstod, inklusive en fullständig stackspårning	Standardalternativet är Normal .

Inställning

Beskrivning

Anteckningar

Gräns för platspris

Ställ in den maximala kostnaden för frågekomplexitet för alla kunder per minut.

Standardvärdet är 500 000.

Gräns för klientpris

Ställ in den maximala kostnaden för frågekomplexitet per minut för en enskild klient.

Du kan konfigurera denna gräns för enskilda klienter genom att redigera deras inställningar . Standardvärdet är 250 000.

Maximal komplexitet i fråga

Ställ in den maximala komplexitet som tillåts för en enda fråga.

Standardvärdet är 6 000.

Maximalt frågedjup

Ställ in maximalt tillåtet djup för en enda fråga.

Standardvärdet är 15.

Standardutgång för token

Detta ställer in standardlängden för tidstokens som kommer att vara giltiga när nya API-klienter läggs till. Använd de två rullgardinsmenyerna för att ställa in värde och tidsenhet (t.ex. timmar, dagar, veckor).

Du kan konfigurera utgångsdatumet för token för varje klient genom att redigera deras inställningar . Standardtiden är 24 timmar.

Standardsvar för fel

Denna inställning avgör hur mycket information som kommer att tillhandahållas i API-svar när fel uppstår. Välj ett av följande alternativ:

Ingen: API-svar kommer inte att ge någon specifik information om felet
Normal: API-svar kommer att ge specifik information om varför felet uppstod
Utvecklare: API-svar kommer att ge specifik information om varför felet uppstod, inklusive en fullständig stackspårning

Standardalternativet är Normal .

API-inställningar

What's Next