Kom i gang med Microsoft Learn Platform API'en

Denne artikel hjælper dig med at komme i gang med at bruge Microsoft Learn Platform API. Hvis du ikke er bekendt med detaljerne i API'et eller brugsscenarierne for det, anbefaler vi, at du først gennemgår artiklen om Microsoft Learn Platform API Oversigt .

Lær Platform API-autentificering

Learn Platform REST API'erne bruger Microsoft Entra ID til autentificering. Før du laver API-kald, skal du vælge en adgangsmetode, og din klientapplikation skal autentificere med gyldige legitimationsoplysninger.

Kun app-adgang

Når din app direkte tilgår Learn, er adgangen ikke bundet til en enkelt bruger. Appen kalder API'er direkte ved hjælp af sin egen identitet, dette scenarie er kun app-adgang. Lær mere på Microsofts identitetsplatform.

For at komme i gang skal du have en gyldig identitet på Microsoft Identity Platform, som kan være en app-registrering eller en administreret identitet. Ideelt set bør hver partner have én identitet for at forenkle kvote- og partnerstyring. Brug af en brugertildelt administreret identitet kan hjælpe med at forene administrerede identiteter på tværs af forskellige tjenester.

Når din Entra ID-identitet er oprettet, skal du få en adgangstoken fra Entra ID med scope sat til som bevis for autentificering. Inkludér adgangstoken i HTTP-autorisationsheaderen, når du laver REST API-anmodninger om at lære.

Delegeret adgang

Når en bruger logger ind på din app og bruger den til at få adgang til Learn, skal appen først bede om tilladelse til at få adgang til denne ressource på brugerens vegne. Dette scenarie kaldes delegeret adgang. Lær mere på Microsofts identitetsplatform.

For at komme i gang skal du registrere en ansøgning. Når din app-registrering er oprettet, skal din app bede brugeren om at tildele et specifikt scope eller et sæt scopes for at få adgang til Learn på brugerens vegne. Learn giver en liste over scopes for fintgået adgang til ressourcer. Listen over teleskoper omfatter:

• : Dette omfang giver brugerne adgang til offentligt indhold på Learn, hvor de udgiver sig for at være den indloggede bruger.

Forståelse af Microsoft Learn Platform API-versionering

Når der foretages ændringer i API'en, udgiver vi en ny, forældet version. Breaking changes er ændringer, der potentielt kan ødelægge en integration. Eventuelle ikke-brydende (additive) ændringer vil være tilgængelige i alle understøttede API-versioner.

API-versionen specificeres som api-version forespørgselsparameter og bruger yyyyy-MM-dd til stabile versioner og yyyy-MM-dd-preview til preview-versioner. API-versionens forespørgselsparameter er påkrævet for hver API-anmodning.

Når en ny stabil API-version udgives, understøttes den tidligere stabile API-version i mindst 24 måneder efter udgivelsen af den nye API-version. Preview-API'er har en kortere supportcyklus på yderligere tre måneder efter udgivelsen af nye preview-API'er.

Den nuværende version er 2023-11-01-preview.

/v1/ URL-segmentet før hvert API er en del af basis-URL'en, ikke API-versionen. Det er forbeholdt betydelige ændringer i API-protokol og mønster i fremtiden.

Lær Platform API Rate Limiting

Learn begrænser antallet af REST API-anmodninger, du kan lave inden for en bestemt tidsramme. Denne grænse hjælper med at forhindre misbrug og denial-of-service-angreb og sikrer, at API'en forbliver tilgængelig for alle brugere.

Learn anvender hastighedsgrænser baseret på oid-kravet i adgangstoken. For adgang kun til appen anvendes grænsen på selve appen, mens for delegeret adgang anvendes grænsen på brugeren, der er logget ind i appen.

Som standard er hastighedsgrænsen 100 API-kald pr. minut, beregnet over et 5-minutters vindue. Hvis du har brug for en højere produktionsgrænse, kan du kontakte Learn Integrations Support for at anmode om en forhøjelse.

Visse API'er, som knowledge search API'en, implementerer også token-baseret rate limiting. Dette er baseret på antallet af forbrugte Microsoft Azure OpenAI-tokens, med en standardgrænse på 10.000 tokens pr. minut. For at øge denne produktionsgrænse, kontakt Learn Integrations Support.

Lær Platform API Paginering

Alle topniveau API-ressourcer understøtter massehentning via 'liste' API-metoder. For eksempel kan du hente lister over moduler eller eksamener. Disse metoder returnerer paginerede svar efter en standardiseret tilgang.

List API-metoder bruger cursorbaseret paginering, angivet af nextLink-feltet i svarkroppen. Dette felt indeholder en uigennemsigtig URL med de oplysninger, der er nødvendige for at hente næste resultatside. Som standard returnerer liste-API'er 30 elementer pr. anmodning, men du kan justere sidestørrelsen ved hjælp af maxpagesize-parameteren.

Vores klient-SDK-biblioteker tilbyder autopagineringshjælpere til at gennemgå alle sider i en liste.

Relateret indhold

• Quickstart: Opsæt og brug Microsoft Learn Platform API Catalog Data
• Lær Platform API Katalog Data Udviklerreference
• Lær Platform API FAQ