Kom i gang med Microsoft Learn Platform API

Denne artikkelen hjelper deg med å komme i gang med å bruke Microsoft Learn Platform API. Hvis du ikke er kjent med detaljene i API-et eller bruksområdene for det, anbefaler vi at du først leser artikkelen om Microsoft Learn Platform API Oversikt .

Lær Platform API-autentisering

Learn Platform REST-API-ene bruker Microsoft Entra ID for autentisering. Før du foretar API-kall, må du velge en tilgangsmetode, og klientapplikasjonen din må autentisere med gyldige legitimasjoner.

Kun app-tilgang

Når appen din får direkte tilgang til Learn, er ikke tilgangen knyttet til én enkelt bruker. Appen kaller API-er direkte ved hjelp av sin egen identitet, dette scenariet gir kun tilgang til appen. Lær mer på Microsofts identitetsplattform.

For å komme i gang trenger du en gyldig identitet på Microsoft Identity Platform, som kan være en app-registrering eller en administrert identitet. Ideelt sett bør hver partner ha én identitet for å forenkle kvote- og partnerstyring. Bruk av en brukertildelt administrert identitet kan bidra til å forene administrerte identiteter på tvers av ulike tjenester.

Når din Entra-ID-identitet er satt opp, hent en tilgangstoken fra Entra-ID med scope satt til som autentiseringsbevis. Inkluder tilgangstokenet i HTTP Authorization-headeren når du gjør REST API-forespørsler til Learn.

Delegert tilgang

Når en bruker logger inn i appen din og bruker den for å få tilgang til Learn, må appen først be om tillatelse til å få tilgang til denne ressursen på brukerens vegne. Dette scenariet kalles delegert tilgang. Lær mer på Microsofts identitetsplattform.

For å komme i gang må du registrere en søknadsregistrering. Når appregistreringen din er satt opp, må appen be brukeren om å tildele et spesifikt scope, eller et sett med scopes, for å få tilgang til Learn på vegne av brukeren. Learn gir en liste over scopes for detaljert tilgang til ressurser. Listen over omfang inkluderer:

• : Dette omfanget lar brukere få tilgang til offentlig innhold på Learn ved å utgi seg for å være den innloggede brukeren.

Forståelse av Microsoft Learn Platform API-versjonering

Når det gjøres endringer i API-et, slipper vi en ny, utdatert versjon. Breaking changes er endringer som potensielt kan ødelegge en integrasjon. Alle ikke-brytende (additive) endringer vil være tilgjengelige i alle støttede API-versjoner.

API-versjonen er spesifisert som api-versjon spørringsparameter og bruker yyyy-MM-dd for stabile versjoner og yyyy-MM-dd-preview for forhåndsvisningsversjoner. API-versjonens spørringsparameter er nødvendig for hver API-forespørsel.

Når en ny stabil API-versjon slippes, støttes den forrige stabile API-versjonen i minst 24 måneder etter utgivelsen av den nye API-versjonen. Forhåndsvisnings-API-er har en kortere støttesyklus på tre måneder etter lanseringen av nye forhåndsvisnings-API-er.

Den nåværende versjonen er 2023-11-01-forhåndsvisning.

/v1/ URL-segmentet før hvert API er en del av basis-URL-en, ikke API-versjonen. Den er reservert for betydelige endringer i API-protokoller og mønstre i fremtiden.

Lær plattformens API-hastighetsbegrensning

Learn begrenser antall REST API-forespørsler du kan gjøre innenfor en bestemt tidsramme. Denne grensen bidrar til å forhindre misbruk og tjenestenektangrep, og sikrer at API-et forblir tilgjengelig for alle brukere.

Learn anvender hastighetsgrenser basert på oid-kravet i tilgangstokenet. For kun app-tilgang brukes grensen på selve appen, mens for delegert tilgang gjelder grensen på brukeren som er logget inn i appen.

Som standard er hastighetsgrensen 100 API-kall per minutt, beregnet over et 5-minutters vindu. Hvis du trenger en høyere produksjonsgrense, kan du kontakte Learn Integrations Support for å be om en økning.

Visse API-er, som kunnskapssøke-API-et, implementerer også token-basert hastighetsbegrensning. Dette baseres på antall forbrukte Microsoft Azure OpenAI-tokens, med en standardgrense på 10 000 tokens per minutt. For å øke denne produksjonsgrensen, kontakt Learn Integrations Support.

Lær plattform-API-paginering

Alle toppnivå API-ressurser støtter massehenting via 'liste' API-metoder. For eksempel kan du hente lister over moduler eller eksamener. Disse metodene returnerer paginerte svar etter en standardisert tilnærming.

List API-metoder bruker kursorbasert paginering, indikert av nextLink-feltet i svarkroppen. Dette feltet inneholder en ugjennomsiktig URL med informasjonen som trengs for å hente neste resultatside. Som standard returnerer liste-API-er 30 elementer per forespørsel, men du kan justere sidestørrelsen ved å bruke maxpagesize-parameteren.

Våre klient-SDK-biblioteker tilbyr autopagineringshjelpere for å navigere gjennom alle sidene i en liste.

Relatert innhold

• Quickstart: Sett opp og bruk Microsoft Learn Platform API-katalogdata
• Lær Platform API Catalog Data Developer Reference
• Lær Platform API FAQ