Începe cu API-ul Microsoft Learn Platform

Acest articol te ajută să începi să folosești Microsoft Learn Platform API. Dacă nu sunteți familiarizat cu detaliile API-ului sau cu cazurile de utilizare ale acestuia, vă recomandăm să consultați mai întâi articolul de prezentare generală a API-ului Microsoft Learn Platform .

Autentificarea API-ului Învață platforma

API-urile REST ale platformei Learn folosesc Microsoft Entra ID pentru autentificare. Înainte de a efectua apeluri API, trebuie să alegi o metodă de acces, iar aplicația ta client trebuie să se autentifice cu acreditări valide.

Acces doar prin aplicație

Când aplicația ta accesează direct Learn, accesul său nu este legat de niciun utilizator individual. Aplicația apelează direct la API-uri folosindu-și propria identitate, acest scenariu fiind acces doar prin aplicație. Află mai multe despre Microsoft Identity Platform.

Pentru a începe, ai nevoie de o identitate validă pe Microsoft Identity Platform, care poate fi o înregistrare a aplicației sau o identitate gestionată. Ideal, fiecare partener ar trebui să aibă o singură identitate pentru a simplifica gestionarea cotelor și a partenerilor. Utilizarea unei identități gestionate atribuite de utilizator poate ajuta la unificarea identităților gestionate între diferite servicii.

Odată ce identitatea ta Entra ID este configurată, obține un token de acces de la Entra ID, cu scopul setat ca dovadă de autentificare. Include tokenul de acces în antetul HTTP Authorization atunci când faci cereri REST API către Learn.

Acces delegat

Când un utilizator se conectează la aplicația ta și o folosește pentru a accesa Learn, aplicația trebuie mai întâi să ceară permisiunea de a accesa această resursă în numele utilizatorului. Acest scenariu se numește acces delegat. Află mai multe despre Microsoft Identity Platform.

Pentru a începe, trebuie să înregistrezi o aplicație. Odată ce înregistrarea aplicației este configurată, aplicația trebuie să ceară utilizatorului să acorde un anumit scop sau set de scope pentru a accesa Learn în numele utilizatorului. Learn oferă o listă de domenii pentru acces detaliat la resurse. Lista lunetei include:

• : Acest domeniu permite utilizatorilor să acceseze conținut public pe Learn deghizat ca utilizator autentificat.

Înțelegerea versiunării API-ului Microsoft Learn Platform

Când se fac modificări majore la API, lansăm o versiune nouă, datată. Schimbările rupte sunt schimbări care pot putea strica o integrare. Orice modificări non-breaking (aditive) vor fi disponibile în toate versiunile API suportate.

Versiunea API-ului este specificată ca parametru de interogare api versiune și folosește yyyy-MM-dd pentru versiunile stabile și yyyy-MM-dd-preview pentru versiunile de previzualizare. Parametrul de interogare versiune API este necesar pentru fiecare cerere API.

Când este lansată o nouă versiune stabilă a API-ului, versiunea anterioară stabilă este suportată cel puțin încă 24 de luni după lansarea noii versiuni API. API-urile de previzualizare au un ciclu de suport mai scurt, de încă trei luni, după lansarea noilor API-uri de previzualizare.

Versiunea actuală este 2023-11-01-preview.

Segmentul URL /v1/ de dinaintea fiecărui API face parte din URL-ul de bază, nu versiunea API-ului. Este rezervată pentru schimbări substanțiale de protocoale API și tipare în viitor.

Învață limitarea ratei API-ului platformei

Learn limitează numărul de cereri REST API pe care le poți face într-un anumit interval de timp. Această limită ajută la prevenirea abuzurilor și a atacurilor de tip denial-of-service și asigură că API-ul rămâne disponibil pentru toți utilizatorii.

Learn aplică limite de rată bazate pe revendicarea OID din tokenul de acces. Pentru accesul doar în aplicație, limita se aplică aplicației în sine, în timp ce pentru accesul delegat, limita se aplică utilizatorului autentificat în aplicație.

În mod implicit, limita de rată este de 100 de apeluri API pe minut, calculată pe o fereastră de 5 minute. Dacă aveți nevoie de o limită mai mare pentru producție, puteți contacta Suportul Learn Integrations pentru a solicita o creștere.

Anumite API-uri, precum API-ul de căutare a cunoștințelor, implementează de asemenea limitare a ratei bazată pe token. Aceasta se bazează pe numărul de tokenuri Microsoft Azure OpenAI consumate, cu o limită implicită de 10.000 de tokenuri pe minut. Pentru a crește această limită de producție, contactați Suportul pentru Integrări Learn.

Learn Platform API Pagination

Toate resursele API de top suportă regăsirea în masă prin metode API "listă". De exemplu, poți recupera liste de module sau examene. Aceste metode returnează răspunsuri paginate urmând o abordare standardizată.

Metodele API de listă folosesc paginare bazată pe cursor, indicată de câmpul nextLink din corpul răspunsului. Acest câmp conține un URL opac cu informațiile necesare pentru a obține pagina următoare cu rezultate. Implicit, API-urile listelor returnează 30 de elemente per cerere, dar poți ajusta dimensiunea paginii folosind parametrul maxpagesize.

Bibliotecile noastre de SDK pentru clienți oferă ajutor de autopaginare pentru a parcurge toate paginile unei liste.

Conținut asociat

• Pornire rapidă: Configurați și folosiți datele de catalog ale API-ului Microsoft Learn Platform
• Learn Platform API Catalog Data Reference pentru dezvoltatori
• Află întrebări frecvente despre API-ul platformei