Visa API-dokumentation
  • 24 Jan 2025
  • 1 Minut att läsa

Visa API-dokumentation


Sammanfattning av artikeln

Även om vi rekommenderar att granska API-dokumentationen på din Totara-webbplats för den mest exakta och uppdaterade informationen, kan du se generisk referensdokumentation i vår utvecklardokumentation om du inte har tillgång till en Totara-webbplats.

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 vill att deras API-tjänster ska visas i API-dokumentationen, behöver 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 behörighet 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:

  1. Navigera till snabbåtkomstmenyn > Utveckling > API > API-dokumentation .
  2. Använd innehållsförteckningen i kolumnen till vänster för att hoppa till ett specifikt avsnitt.
  3. 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.

Visa API-dokumentationen i Totara.

Join the Totara Community for more resources to help you get the most out of Totara. You can also book a call to have a chat about your Totara platform with a dedicated Customer Success Manager.


© Copyright 2025 Totara Learning Solutions. All rights reserved.


Var den här artikeln till hjälp?

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.