Udostępnij za pośrednictwem

Dokumentacja interfejsu API REST

Platforma szkoleń społeczności firmy Microsoft uwidacznia swoje interfejsy API na potrzeby integracji z inną usługą lub aplikacją. Interfejsy API umożliwiają automatyzowanie przepływów i tworzenie nowych funkcji na podstawie wbudowanych funkcji platformy szkoleniowej.

W tym artykule dowiesz się więcej na temat podpisów interfejsu API i ich przepływów uwierzytelniania w odpowiednich sekcjach.

Podpisy interfejsu API

Zastosuj poniższe kroki, aby uzyskać dostęp do sygnatur interfejsu API REST udostępnianych przez platformę szkoleń społeczności firmy Microsoft.

  1. W witrynie Azure Portal wyszukaj i wybierz pozycję App Services, a następnie wybierz aplikację.

    azure home 1.png

  2. W menu po lewej stronie aplikacji wybierz pozycję Ustawienia aplikacji konfiguracji > i kliknij pozycję Nowe ustawienia aplikacji.

    setting.png aplikacji

  3. W oknie podręcznym wpisz następujące wartości i kliknij przycisk OK.

    Nazwa: EnableSwagger

    Wartość: true

    popup-swagger.png

  4. Kliknij ikonę zapisywania, aby zapisać zmiany.

    ikona zapisywania

  5. Po zaimplementowaniu powyższych zmian administratorzy portalu będą mogli pobrać podpis interfejsu API, wpisując w adresie URL witryny internetowej ciąg /swagger w przeglądarce internetowej. (https://website-url/swagger)

Uwaga

Jeśli adres URL portalu witryny internetowej to https://mcttraining.azurewebsites.net Wtedy, struktura adresu URL dla sygnatury interfejsu API: https://mcttraining.azurewebsites.net/swagger

Ostrzeżenie

(W tej samej przeglądarce) Aby uzyskać dostęp do linku struktury Swagger dla twojego wystąpienia, musisz zalogować się jako administrator w portalu szkoleniowym.

Uwierzytelnianie interfejsu API

Użytkownik może uwierzytelnić się przy użyciu interfejsów API szkoleń społeczności firmy Microsoft przy użyciu jednej z następujących metod.

Metoda 1. Uwierzytelnianie za pomocą usługi

Aby programowo uzyskać token dostępu, postępuj zgodnie z tym dokumentem w celu uwierzytelniania usługi w usłudze.

Metoda 2. Uwierzytelnianie za pośrednictwem tokenów

Aby ręcznie uzyskać token dostępu (na potrzeby testowania), wykonaj następujące kroki:

  1. Otwórz przeglądarkę.

  2. Otwórz okno inspekcji. (Skrót: naciśnij Ctrl + Shift + I lub kliknij prawym przyciskiem myszy i wybierz pozycję Sprawdź)

  3. W oknie Inspekcja przejdź do karty Sieć

  4. Teraz w przeglądarce wywołaj adres URL :"https:// {your-MCT-portal-domain} /ExternalAuthentication/Login".

    Na przykład: Aby uzyskać token na https://mctdemo2.azurefd.net przykład, możemy wywołać mctdemo2.azurefd.net/ExternalAuthentication/Login

  5. Wprowadź poświadczenia na stronie logowania. Kliknij pozycję Zaloguj.

  6. W oknie Inspekcja na karcie Sieć kliknij opcję Wywołanie zwrotne.

  7. W nagłówkach zostanie wyświetlona kategoria "lokalizacja", która zawiera token dostępu i token odświeżania.

    Inspekcja tokenu

  8. Użyj tokenu AccessToken , aby wywołać interfejsy API REST (np. bearer AccessToken)

    Uwaga

    Przykładowe polecenie CURL

    curl --location --request GET 'https://contoso.azurefd.net/api/v2/Profile' \--header 'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ilg1ZVhrNHh5b2pORnVtMWtsMll0djhkbE5QNC1jNTdkTzZRR1RWQndhTmsifQ.eyJpc3MiOiJodHRwczovL21lcmNhZG9jbHAuYjJjbG9naW4uY29tLzMxYjcwYzA3LTljM2ItNDcxZC05MDE4LWI5MDJhNWU2ZTU3Ny92Mi4wLyIsImV4cCI6MTU5NDIwNjE1MSwibmJmIjoxNTk0MjAyNTUxLCJhdWQiOiIxOTQ5YWE3NS1kYjI2LTQ0Y2UtOTU4My00OTNkYTE3NDRlMDkiLCJuYW1lIjoiTklLRVNIIEpPU0hJIiwiaWRwIjoiZ29vZ2xlLmNvbSIsInN1YiI6IjVlMmVlZWNhLTg4Y2ItNGNiOS05ZmI2LTU2MWI4YWNmMmQ1YSIsImpvYlRpdGxlIjoiU0UiLCJlbWFpbHMiOlsibmlrZXNoam9zaGkyMDAxQGdtYWlsLmNvbSJdLCJ0ZnAiOiJCMkNfMV9zaWdudXBzaWduaW4xIiwiYXpwIjoiMTk0OWFhNzUtZGIyNi00NGNlLTk1ODMtNDkzZGExNzQ0ZTA5IiwidmVyIjoiMS4wIiwiaWF0IjoxNTk0MjAyNTUxfQ.Z0wLIlzHIS0A1McQHeKsWmzCVDMOJSVcCmFzWLa99b0YPS7aTyJEIp5lWd9sINtjJRiSmxcAtQP1IOgX3RhuDNRJ6GDib7EMNxi6234HBEB_wsrQ9FDkr3dbLkkU09zP5f4GjBKliuRpiIqX6ukne8InHOgy9ZuJbw43BbiMkj4S1Y5rZlABRgw1ncHGW0x8AE4DB6d9P8Yb9l6R_4NF2tmLp_vlzXQLRAqEI5IlXIDVyNIEWrEwdDvtjXJ_CtiQL7dxHuzDHbzY1NB_lV4KcjXPtdPukr1K9p6D1WoIe4aytJ_4IzG_nJjH-pM_vzxZ4Syift1i0qXra6clRdB2lQ'

  9. Po wygaśnięciu tokenu AccessToken użyj tokenu RefreshToken , aby uzyskać nowy token AccessToken

    Uwaga

    Sygnatura interfejsu API w celu uzyskania tokenu AccessToken przy użyciu metody RefreshToken

    POST <websiteUrl>/api/v1/ExternalAuthToken/RefreshToken/{identityProvider}

{identityprovider} = PHONE/EMAIL/AZUREAD

Body:
{
"RefreshToken":"<Token>"
}

Ostrzeżenie

Token odświeżania" może służyć do zwiększenia ważności tokenu AccessToken. Data wygaśnięcia tokenu RefreshToken będzie zależeć od typu uwierzytelniania wystąpienia platformy.

Po wygaśnięciu tokenu RefreshToken użytkownik będzie musiał zalogować się do wystąpienia jawnie, aby uzyskać nowy token AccessToken i RefreshToken (chyba że używasz uwierzytelniania S2S).

Zazwyczaj token AccessToken jest ważny przez 24 godziny, a token RefreshToken jest ważny przez 90 dni.

Schemat bazy danych

Zapoznaj się z tym dokumentem , aby uzyskać szczegółowe informacje na temat schematu bazy danych.