Kom igång med Api:et för Microsoft Learn Platform

Den här artikeln hjälper dig att komma igång med api:et för Microsoft Learn Platform. Om du inte är bekant med informationen om API:et eller användningsfallen för det rekommenderar vi att du läser artikeln Översikt över Microsoft Learn Platform API först.

Learn Platform API-autentisering

Rest-API:erna för Learn Platform använder Microsoft Entra ID för autentisering. Innan du gör API-anrop måste du välja en åtkomstmetod och klientprogrammet måste autentisera med giltiga autentiseringsuppgifter.

Åtkomst endast för appar

När appen har direktåtkomst till Learn är dess åtkomst inte kopplad till någon enskild användare. Appen anropar API:er direkt med sin egen identitet. Det här scenariot är endast appåtkomst. Läs mer på Microsofts identitetsplattform.

För att komma igång behöver du en giltig identitet på Microsoft Identity Platform, som kan vara en appregistrering eller en hanterad identitet. Helst bör varje partner ha en enda identitet för att förenkla kvoten och partnerhanteringen. Att använda en användartilldelad hanterad identitet kan hjälpa till att förena hanterade identiteter mellan olika tjänster.

När din Entra-ID-identitet har konfigurerats hämtar du en åtkomsttoken från Entra-ID med omfånget inställt på som autentiseringsbevis. Inkludera åtkomsttoken i HTTP-auktoriseringshuvudet när du gör REST API-begäranden till Learn.

Delegerad åtkomst

När en användare loggar in på din app och använder den för att komma åt Learn måste appen först be om behörighet att komma åt den här resursen för användarens räkning. Det här scenariot kallas delegerad åtkomst. Läs mer på Microsofts identitetsplattform.

För att komma igång måste du registrera en appregistrering. När appregistreringen har konfigurerats måste appen be användaren att bevilja ett specifikt omfång eller en uppsättning omfång för att få åtkomst till Learn för användarens räkning. Learn innehåller en lista över omfång för detaljerad resursåtkomst. Listan över behörighetsområden är:

• : Det här omfånget gör det möjligt för användare att komma åt offentligt innehåll på Learn som personifieras som den inloggade användaren.

Förstå versionshantering för Microsoft Learn Platform API

När icke-bakåtkompatibla ändringar görs i API:et släpper vi en ny, daterad version. Icke-bakåtkompatibla ändringar är ändringar som potentiellt kan bryta en integrering. Alla icke-störande (additiva) ändringar kommer att vara tillgängliga i alla stödda API-versioner.

API-versionen anges som api-version frågeparameter och använder åååå-MM-dd för stabila versioner och åååå-MM-dd-preview för förhandsversioner. Frågeparametern api-version krävs för varje API-begäran.

När en ny stabil API-version släpps stöds den tidigare stabila API-versionen i minst 24 månader till efter lanseringen av den nya API-versionen. Förhandsversions-API:er har en kortare supportcykel på ytterligare tre månader efter lanseringen av nya förhandsversions-API:er.

Den aktuella versionen är 2023-11-01-preview.

Segmentet /v1/URL innan varje API ingår i bas-URL:en, inte API-versionen. Det är reserverat för betydande API-protokoll och mönsterändringar i framtiden.

Hastighetsbegränsning för Learn Platform API

Learn begränsar antalet REST API-begäranden som du kan göra inom en viss tidsperiod. Den här gränsen hjälper till att förhindra missbruk och överbelastningsattacker och säkerställer att API:et förblir tillgängligt för alla användare.

Learn tillämpar begränsningar av hastighet baserat på "oid"-fältet i åtkomsttoken. För endast appåtkomst tillämpas gränsen på själva appen, medan gränsen för delegerad åtkomst tillämpas på den användare som är inloggad i appen.

Som standard är hastighetsgränsen 100 API-anrop per minut, beräknat över ett 5-minutersfönster. Om du behöver en högre gräns för produktion kan du kontakta Learn Integrations Support för att begära en ökning.

Vissa API:er, till exempel API:et för kunskapssökning, implementerar även tokenbaserad hastighetsbegränsning. Detta baseras på antalet förbrukade Microsoft Azure OpenAI-token, med en standardgräns på 10 000 token per minut. Om du vill öka den här gränsen för produktion, kontakta Support för Learn-Integreringar.

API-paginering för Learn Platform

Alla API-resurser på den översta nivån stöder masshämtning via "list"-API-metoder. Du kan till exempel hämta listor över moduler eller prov. Dessa metoder returnerar sidnumrerade svar enligt en standardiserad metod.

List-API-metoder använder markörbaserad sidnumrering, vilket anges av fältet nextLink i svarstexten. Det här fältet innehåller en ogenomskinlig URL med den information som behövs för att hämta nästa resultatsida. Som standard returnerar list-API:er 30 objekt per begäran, men du kan justera sidstorleken med parametern maxpagesize.

Våra klient-SDK-bibliotek erbjuder hjälp för automatisk sidnumrering för att bläddra igenom alla sidor i en lista.

Relaterat innehåll

• Snabbstart: Konfigurera och använda katalogdata för Microsoft Learn Platform API Catalog
• Learn Platform API Catalog Data Developer-referens
• Vanliga frågor och svar om Learn Platform API