Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Dit artikel helpt u aan de slag te gaan met de Microsoft Learn Platform-API. Als u niet bekend bent met de details van de API of de use cases voor deze API, raden we u aan eerst het artikel Microsoft Learn Platform API Overview te raadplegen.
Learn Platform API-authenticatie
De REST API's van het Learn Platform gebruiken Microsoft Entra-id voor verificatie. Voordat u API-aanroepen maakt, moet u een toegangsmethode kiezen en moet uw clienttoepassing worden geverifieerd met geldige referenties.
Alleen-app-toegang
Wanneer uw app rechtstreeks toegang heeft tot Learn, is de toegang ervan niet gekoppeld aan één gebruiker. De app roept API's rechtstreeks aan met behulp van een eigen identiteit. Dit scenario is alleen-app-toegang. Meer informatie over Microsoft Identity Platform.
Om aan de slag te gaan, hebt u een geldige identiteit nodig op het Microsoft Identity Platform. Dit kan een app-registratie of een beheerde identiteit zijn. In het ideale geval moet elke partner één identiteit hebben om het quotum en partnerbeheer te vereenvoudigen. Het gebruik van een door de gebruiker toegewezen beheerde identiteit kan helpen bij het samenvoegen van beheerde identiteiten in verschillende services.
Zodra uw Entra-id is ingesteld, verkrijgt u een toegangstoken van Entra-id waarbij het bereik is ingesteld https://learn.microsoft.com/.default als bewijs van verificatie. Neem het toegangstoken op in de HTTP-autorisatieheader bij het maken van REST API-aanvragen voor Learn.
Gedelegeerde toegang
Wanneer een gebruiker zich aanmeldt bij uw app en deze gebruikt voor toegang tot Learn, moet de app eerst om toestemming vragen om toegang te krijgen tot deze resource namens de gebruiker. Dit scenario wordt gedelegeerde toegang genoemd. Meer informatie over Microsoft Identity Platform.
Om aan de slag te gaan, moet u een app-registratie registreren. Zodra uw app-registratie is ingesteld, moet uw app de gebruiker vragen om een specifieke bevoegdheid of een reeks bevoegdheden te verlenen om namens de gebruiker toegang te krijgen tot Learn. Learn biedt een lijst met scopes voor fijnmazige resourcetoegang. De lijst met scopes omvat:
-
https://learn.microsoft.com/PublicContent.Read.All: Met dit bereik kunnen gebruikers toegang krijgen tot openbare inhoud op Learn, waarbij ze handelen als de aangemelde gebruiker.
Informatie over api-versiebeheer voor Microsoft Learn Platform
Wanneer belangrijke wijzigingen in de API worden aangebracht, brengen we een nieuwe, gedateerde versie uit. Brekende wijzigingen zijn wijzigingen die een integratie kunnen verbreken. Eventuele niet-brekende (additieve) wijzigingen zijn beschikbaar in alle ondersteunde API-versies.
API-versie wordt opgegeven als queryparameter voor api-versie en gebruikt jjjj-MM-dd voor stabiele versies en jjjj-MM-dd-preview voor preview-versies. De queryparameter api-versie is vereist voor elke API-aanvraag.
Wanneer er een nieuwe stabiele API-versie wordt uitgebracht, wordt de vorige stabiele API-versie ten minste 24 maanden ondersteund na de release van de nieuwe API-versie. Preview-API's hebben een kortere ondersteuningscyclus van drie maanden na de release van nieuwe preview-API's.
De huidige versie is 2023-11-01-preview.
Het /v1/URL-segment voordat elke API deel uitmaakt van de basis-URL, niet de API-versie. Het is gereserveerd voor aanzienlijke WIJZIGINGEN in het API-protocol en -patroon in de toekomst.
Snelheidsbeperking voor Learn Platform-API
Learn beperkt het aantal REST API-aanvragen dat u binnen een bepaalde tijd kunt indienen. Deze limiet helpt misbruik en denial-of-service-aanvallen te voorkomen en zorgt ervoor dat de API beschikbaar blijft voor alle gebruikers.
Learn past frequentielimieten toe op basis van de oid-claim in het toegangstoken. Voor alleen-app-toegang wordt de limiet toegepast op de app zelf, terwijl voor gedelegeerde toegang de limiet wordt toegepast op de gebruiker die is aangemeld bij de app.
Standaard is de frequentielimiet 100 API-aanroepen per minuut, berekend in een venster van 5 minuten. Als u een hogere limiet voor productie nodig hebt, kunt u contact opnemen met de ondersteuning van Learn Integrations om een verhoging aan te vragen.
Bepaalde API's, zoals de Knowledge Search-API, implementeren ook snelheidsbeperking op basis van tokens. Dit is gebaseerd op het aantal verbruikte Microsoft Azure OpenAI-tokens, met een standaardlimiet van 10.000 tokens per minuut. Als u deze limiet voor productie wilt verhogen, neemt u contact op met de ondersteuning van Learn Integrations.
Paginering voor API van het Learn Platform
Alle API-resources op het hoogste niveau ondersteunen bulkgewijs ophalen via lijst-API-methoden. U kunt bijvoorbeeld lijsten met modules of examens ophalen. Deze methoden retourneren gepagineerde antwoorden volgens een gestandaardiseerde benadering.
List-API-methoden maken gebruik van op cursor gebaseerde paginering, aangegeven door het nextLink-veld in de hoofdtekst van het antwoord. Dit veld bevat een ondoorzichtige URL met de informatie die nodig is om de volgende pagina met resultaten op te halen. Standaard retourneren lijst-API's 30 items per aanvraag, maar u kunt het paginaformaat aanpassen met behulp van de parameter maxpagesize.
Onze client-SDK-bibliotheken bieden helpers voor automatische paginering om alle pagina's van een lijst te bekijken.