API-documentatie bekijken

Bijgewerkt op 28 Feb 2024
1 Minuut om te lezen

Article Summary

Share feedback

Thanks for sharing your feedback!

Wanneer je werkt met de externe API in Totara, wil je misschien een API-referentiegids zien, die alle services beschrijft die beschikbaar zijn in de API en hoe je ze moet gebruiken. Totara heeft ingebouwde referentiedocumentatie gegenereerd uit het GraphQL-schema. Deze documentatie weerspiegelt de API-functies die beschikbaar zijn voor de specifieke versie van Totara die de site gebruikt, en bevat diensten die zijn toegevoegd of gewijzigd door codeaanpassingen van derden.

Let op dat de API-documentatie de officiële Totara-versie weerspiegelt die de site gebruikt. Als je codeaanpassingen maakt en je wil dat hun API-services in de API-documentatie verschijnen, moet je deze opnieuw opbouwen om deze wijzigingen op deze pagina weer te geven. Als de huidige documentatie verouderd is, dan zal de API documentatiepagina een waarschuwing tonen die dit aangeeft.

Alleen gebruikers met de totara/api:viewdocumentation mogelijkheid hebben toegang tot de API-documentatie. Standaard omvat dit sitebeheerders, sitebeheerders en tenantdomeinbeheerders.

Doe het volgende om de documentatie te bekijken:

Navigeer naar het snelmenu > Ontwikkeling > API > API documentatie.
Gebruik de inhoudstabel in de linkerkolom om naar een specifieke sectie te gaan.
Klik op Terug naar API om terug te keren naar de lijst met API-clients.

Op deze pagina kun je de volgende informatie over de API zien:

Eindpuntdetails
Authenticatie
Vraagformaat
Link naar het API-schema
Beschikbare zoekopdrachten en mutaties
Beschikbare types

De documentatiepagina bevat voorbeelden van het formaat van zowel het specifieke verzoek als het antwoord dat wordt geretourneerd vanuit de API.

API-documentatie bekijken in Totara.

Was dit artikel nuttig?

What's Next

Logbestanden van API-aanvragen bekijken