Visa API-dokumentation
- 08 Apr 2024
- 1 Minut att läsa
Visa API-dokumentation
- Uppdaterad på 08 Apr 2024
- 1 Minut att läsa
Article Summary
Share feedback
Thanks for sharing your feedback!
När du arbetar med det externa API:et i Totara kanske du vill se en referensguide för API, som beskriver alla tjänster som finns tillgängliga i API:et och hur du använder dem. Totara har inbyggd referensdokumentation som genereras från GraphQL-schemat. Denna dokumentation kommer att återspegla de API-funktioner som är tillgängliga för den specifika versionen av Totara som webbplatsen kör, och kommer att inkludera tjänster som läggs till eller modifieras av tredjepartskodanpassningar.
Observera att API-dokumentationen kommer att återspegla den officiella Totara-releasen som webbplatsen använder. Om du gör kodanpassningar och du vill att deras API-tjänster ska visas i API-dokumentationen, måste du bygga om den för att dessa ändringar ska återspeglas på denna sida. Om den aktuella dokumentationen är inaktuell kommer API-dokumentationssidan att visa en varning som indikerar detta.
Endast användare med totara/api:viewdocumentation rättighet kan komma åt API-dokumentationen. Som standard inkluderar detta platsadministratörer, platschefer och domänchefer för hyresgäster.
Gör så här för att visa dokumentationen:
- Navigera till snabbåtkomstmenyn > Utveckling > API > API-dokumentation .
- Använd innehållsförteckningen i kolumnen till vänster för att hoppa till ett specifikt avsnitt.
- Klicka på Tillbaka till API för att återgå till listan med API-klienter.
På denna sida kan du se följande information om API:
- Uppgifter om slutpunkt
- Autentisering
- Format för begäran
- Länk till API-schemat
- Tillgängliga frågor och mutationer
- Tillgängliga typer
Dokumentationssidan innehåller exempel på formatet för både den specifika begäran och det svar som kommer att returneras från API.
© Copyright 2024 Totara Learning Solutions. All rights reserved.
Var den här artikeln till hjälp?
