API-instellingen

De API heeft een aantal configuratie-instellingen die het gedrag ervan op siteniveau controleren. Sitebeheerders kunnen de algemene API-instellingen voor je site configureren door te navigeren naar het snelmenu API->>instellingen voor > ontwikkeling.

Alleen gebruikers met de totara/api:managesettings mogelijkheid kunnen API-instellingen op siteniveau configureren. Dit geldt standaard ook voor sitebeheerders en sitebeheerders. Tenantgebruikers zullen beperkt zijn tot het aanbrengen van wijzigingen op clientniveau.

Onderstaande tabel beschrijft de API-instellingen die op site niveau kunnen gedefinieerd worden. Sommige instellingen kunnen ook worden geconfigureerd op individueel clientniveau.

Voor meer informatie over tarieflimieten en querycomplexiteit, zie de ontwikkelaarsdocumentatie.

Instelling	Omschrijving	Notities
Limiet voor sitesnelheid	Stel de maximale kosten voor querycomplexiteit in voor alle clients per minuut.	De standaardwaarde is 500.000.
Client rate limiet	Stel de maximale kosten per minuut voor querycomplexiteit in voor één enkele client.	Je kunt deze limiet voor individuele clients configureren door hun instellingen te bewerken. De standaardwaarde is 250.000.
Maximale query complexiteit	Stel de maximale complexiteit in die is toegestaan voor één query.	De standaardwaarde is 6.000.
Maximale query diepte	Stel de maximale diepte in die is toegestaan voor één query.	De standaardwaarde is 15.
Vervaldatum standaard token	Dit stelt de standaard tijdsduur in die tokens geldig zullen zijn bij het toevoegen van nieuwe API-clients. Gebruik de twee dropdownmenu's om de waarde en de tijdseenheid in te stellen (bijv. uren, dagen, weken).	Je kunt het verlopen van het token voor elke client configureren door hun instellingen te bewerken. De standaardduur is 24 uur.
Standaard fout antwoord	Deze instelling bepaalt hoeveel informatie er in API-antwoorden wordt gegeven wanneer er fouten optreden. Kies een van de volgende opties: Geen: API-reacties zullen geen specifieke informatie over de fout opleveren Normaal: API-reacties zullen specifieke informatie opleveren over waarom de fout is opgetreden Ontwikkelaar: API-reacties zullen specifieke informatie opleveren over waarom de fout is opgetreden, inclusief een volledige stack-spoor	De standaardoptie is Normaal.

Instelling

Omschrijving

Notities

Limiet voor sitesnelheid

Stel de maximale kosten voor querycomplexiteit in voor alle clients per minuut.

De standaardwaarde is 500.000.

Client rate limiet

Stel de maximale kosten per minuut voor querycomplexiteit in voor één enkele client.

Je kunt deze limiet voor individuele clients configureren door hun instellingen te bewerken. De standaardwaarde is 250.000.

Maximale query complexiteit

Stel de maximale complexiteit in die is toegestaan voor één query.

De standaardwaarde is 6.000.

Maximale query diepte

Stel de maximale diepte in die is toegestaan voor één query.

De standaardwaarde is 15.

Vervaldatum standaard token

Dit stelt de standaard tijdsduur in die tokens geldig zullen zijn bij het toevoegen van nieuwe API-clients. Gebruik de twee dropdownmenu's om de waarde en de tijdseenheid in te stellen (bijv. uren, dagen, weken).

Je kunt het verlopen van het token voor elke client configureren door hun instellingen te bewerken. De standaardduur is 24 uur.

Standaard fout antwoord

Deze instelling bepaalt hoeveel informatie er in API-antwoorden wordt gegeven wanneer er fouten optreden. Kies een van de volgende opties:

Geen: API-reacties zullen geen specifieke informatie over de fout opleveren
Normaal: API-reacties zullen specifieke informatie opleveren over waarom de fout is opgetreden
Ontwikkelaar: API-reacties zullen specifieke informatie opleveren over waarom de fout is opgetreden, inclusief een volledige stack-spoor

De standaardoptie is Normaal.

API-instellingen

What's Next