Interfejs API wykazu usługi Microsoft Learn — często zadawane pytania
W tym artykule wymieniono często zadawane pytania dotyczące interfejsu API wykazu usługi Microsoft Learn z odpowiedziami i linkami do dodatkowych informacji zgodnie z potrzebami.
Ogólne
Pyt.: Ile kosztuje korzystanie z interfejsu API wykazu platformy Learn?
Korzystanie z interfejsu API wykazu platformy Learn nie jest kosztowne. Aby uzyskać więcej informacji, zobacz sekcję Dostępność i cennik w artykule Omówienie funkcji interfejsu API wykazu platformy Learn.
Pyt.: Jakie są reguły korzystania z interfejsu API wykazu platformy Learn?
Zobacz Microsoft Learn i Microsoft API Terms of Use (Warunki użytkowania interfejsu API firmy Microsoft).
Pyt.: Czy muszę dołączyć lub pobrać klucze, aby korzystać z interfejsu API wykazu platformy Learn?
L.p. Interfejs API jest publicznie dostępny. Zapoznaj się z artykułem Wprowadzenie do interfejsu API wykazu platformy Learn przy użyciu biblioteki cURL i programu Visual Studio Code i/lub artykułu Learn Catalog API Developer Reference (Dokumentacja dla deweloperów interfejsu API wykazu platformy Learn).
Pyt.: Czy ten interfejs API pozwoli naszym użytkownikom korzystać z zawartości Learn na naszej platformie?
L.p. Interfejs API wykazu platformy Learn udostępnia metadane dotyczące zawartości oraz bezpośrednie linki do zawartości. Użytkownicy mogą zintegrować te linki z dowolnym środowiskiem Edukacja Management System (LMS) lub internetowym zgodnie z warunkami użytkowania interfejsu API firmy Microsoft.
Pyt.: Czy dane zwrócone z interfejsu API wykazu platformy Learn pozostają statyczne lub zmieniają się?
Dane zmieniają się za każdym razem, gdy nowa zawartość zostanie dodana, zmodyfikowana lub usunięta, która jest zwykle codziennie.
Odpowiedź interfejsu API
Pyt.: Czy mogę pobrać wszystkie dane jednocześnie?
Tak. Użyj podstawowego punktu końcowego, learn.microsoft.com/api/catalog, aby uzyskać pełną odpowiedź. Aby uzyskać więcej informacji o żądaniu interfejsu API, zobacz artykuł Learn Catalog API Developer Reference (Dokumentacja dla deweloperów interfejsu API usługi Learn Catalog).
Pyt.: Czy mogę wstępnie filtrować odpowiedź?
Tak. Zapoznaj się z filtrami zapytań dostępnymi w artykule Learn Catalog API Developer Reference (Dokumentacja dla deweloperów interfejsu API wykazu usługi Learn).
Pyt.: Czy identyfikatory UID są unikatowe dla każdego obiektu zawartości?
Tak. UID oznacza "Unikatowy identyfikator" i jest unikatowy dla każdego obiektu zawartości. Jeśli identyfikator UID zmieni się, nawet jeśli tytuł lub inne metadane pozostaną takie same, zawartość jest traktowana jako nowy obiekt.
Pyt.: Dlaczego w podsumowaniu modułu znajdują się tagi HTML?
Zazwyczaj staramy się zachować formatowanie podsumowania tak nieprzetworzone, jak to możliwe, ale czasami musimy podkreślić lub połączyć określony tekst.
Pyt.: Dlaczego nie ma linków dla poszczególnych jednostek?
Jednostki nie są zapisywane jako zawartość autonomiczna. Mają one zostać podjęte w określonej kolejności dla modułu. Z tego powodu dołączymy link do strony szczegółów modułu i pierwszą jednostkę, aby użytkownicy mogli tam rozpocząć pracę i przejść przez zawartość.
Pyt.: Jak mogę powiedzieć, jaka zawartość jest nowa?
Wartość last_modified informuje o ostatniej modyfikacji rekordu.
Pyt.: Czy logowanie jednokrotne jest włączone dla linków do zawartości?
Obecnie nie jest to możliwe. Chcemy włączyć logowanie jednokrotne w przyszłości.
Zawartość
Pyt.: Czy identyfikator UID jest unikatowy dla zawartości?
Tak. UID oznacza "Unikatowy identyfikator" i jest unikatowy dla każdego obiektu zawartości. Jeśli identyfikator UID zmieni się, nawet jeśli tytuł lub inne metadane pozostaną takie same, zawartość jest traktowana jako nowy obiekt.
Pyt.: Czy wszystkie moduły są częścią ścieżki szkoleniowej?
L.p. Moduły są w stanie stanąć w spokoju, w tym sensie, że uczą scenariusza lub koncepcji kompleksowe w nich i nie wymagają podejmowania modułów wymagań wstępnych. Dla niektórych jest to i nie są częścią ścieżki szkoleniowej. W przypadku innych użytkowników są one połączone w jedną lub więcej ścieżek szkoleniowych, które przyjmują użytkownika przez tworzenie bardziej zaawansowanych pojęć. Moduł nie musi być częścią ścieżki szkoleniowej lub może być częścią co najmniej jednej.
Pyt.: Jak mogę wiedzieć, kiedy zawartość została dodana, odświeżona lub usunięta?
Po dodaniu nowych obiektów zawartości są one wyświetlane jako nowy obiekt (zidentyfikowany przez UID) w odpowiedzi. Podczas modyfikowania zawartości można określić na podstawie jej last_modified wartości. Po usunięciu zawartości obiekt zawartości zostanie usunięty z odpowiedzi. Chociaż czasami występuje niewielkie opóźnienie w aktualizowaniu zawartości w odpowiedzi interfejsu API, gdy użytkownik podąża za adresem URL do zawartości, zawsze widzi najbardziej aktualne informacje. Po usunięciu zawartości stary adres URL przekierowuje do nowej zawartości lub środowiska albo do następnej najlepszej opcji.
W szczególności zawartość jest aktualizowana przez cały czas. Publikujemy dostępne aktualizacje dwa razy dziennie. Mogą one być drobne, takie jak drobne zmiany tekstu lub główne, takie jak główne poprawki, dodatki lub usunięcia. Ogólnie rzecz biorąc, portfolio zawartości jest zarządzane jako ogromny, wysoce zarządzany projekt open source z tysiącami współautorów, a w związku z tym zmiany są wykonywane przez cały czas. Jeśli używasz interfejsu API wykazu platformy Learn w systemie produkcyjnym, należy pamiętać o tym i mieć możliwość obsługi tego systemu.
Pyt.: Poszedłem za zakładką link do zawartości, ale teraz pokazuje mi inny fragment zawartości niż oczekiwano. Dlaczego?
Staramy się zapewnić, że nikt nie uderza w martwy (404) z linkami do naszej witryny. Gdy zawartość zostanie zmodyfikowana lub zamieniona, zaimplementujemy przekierowanie starego linku, który automatycznie spowoduje przejście do nowej zawartości. W przypadku, gdy zawartość jest przestarzała i nie jest zastępowana z różnych powodów, nastąpi przekierowanie do następnej najlepszej odpowiedniej zawartości, która może być nieco zmodyfikowanym zakresem lub stroną docelową itp.
Pyt.: Jak mogę uzyskać dostęp do dokumentacji, klipów wideo i przykładowych katalogów kodu?
Obecnie nie ma programowego sposobu uzyskiwania dostępu do tych katalogów. Chcemy umożliwić programowy dostęp do tych katalogów w przyszłości.
Lokalizacja
Pyt.: Jakie języki są dostępne w środowisku Microsoft Learn?
W witrynie Microsoft Learn jest dostępnych ponad 65 ustawień regionalnych. Pełną listę można wyświetlić tutaj za pomocą stopki witryny (wybierz wyświetlany język, aby wyświetlić pełną listę).
Pyt.: Czy zawartość jest dostępna w innych językach?
To zależy. Chcemy udostępnić zawartość we wszystkich językach, w których są dostępne produkty nauczane w treści. Gdy uczniowie odwiedzają witrynę Microsoft Learn w danych ustawieniach regionalnych, jeśli zawartość nie jest dostępna w tych ustawieniach regionalnych, użytkownik zobaczy nagłówek i stopkę w żądanych ustawieniach regionalnych, a podstawowa zawartość jest domyślnie przywracana do języka angielskiego, dopóki nie będzie dostępna zlokalizowana wersja.
Pyt.: Czy zawartość jest inna dla danego obiektu zawartości, w zależności od tego, w jakim języku jest on wyświetlany?
Możliwe. Po opublikowaniu aktualizacji w języku angielskim nasze potoki lokalizacji działają tak szybko, aby zlokalizowane wersje były aktualizowane tak szybko, jak to możliwe — zwykle w ciągu kilku dni od pierwotnej zmiany.
Inne
Pyt.: Czy istnieje interfejs API raportowania lub funkcje pobierania danych, takich jak widoki, kliknięcia, ukończenie?
Obecnie nie mamy interfejsu API raportowania. Mamy funkcje raportowania organizacyjnego, które umożliwiają organizacjom raportowanie na temat ukończenia użytkowników.
Następne kroki
Aby dowiedzieć się więcej na temat interfejsu API wykazu platformy Learn, skorzystaj z następujących linków: