Freigeben über

REST-API-Dokumentation

Die Microsoft Community Training-Plattform macht ihre APIs für die Integration in andere Dienste oder Anwendungen verfügbar. Sie können die APIs verwenden, um Flows zu automatisieren und neue Funktionen zusätzlich zu den Standardfunktionen der Trainingsplattform zu erstellen.

In diesem Artikel erfahren Sie mehr über die API-Signaturen und deren Authentifizierungsflows in den entsprechenden Abschnitten.

API-Signaturen

Führen Sie die folgenden Schritte aus, um auf die Rest-API-Signaturen zuzugreifen, die von der Microsoft Community Training-Plattform verfügbar gemacht werden.

  1. Suchen Sie im Azure-Portal die Option „App Services“, wählen Sie sie aus, und wählen Sie anschließend Ihre App aus.

    azure home 1.png

  2. Wählen Sie im linken Menü der App „Konfiguration“ > „Anwendungseinstellungen“ aus, und klicken Sie dann auf „Neue Anwendungseinstellungen“.

    application setting.png

  3. Geben Sie im Popup die folgenden Werte ein, und klicken Sie dann auf OK.

    Name: EnableSwagger

    Wert: true

    popup-swagger.png

  4. Klicken Sie auf das Symbol „Speichern“, um die Änderungen zu speichern.

    Symbol „Speichern“

  5. Sobald die oben genannten Änderungen implementiert wurden, können Portaladministrator*innen die API-Signatur abrufen, indem sie die URL Ihrer Website gefolgt von /swagger im Webbrowser eingeben. (https://website-url/swagger)

Hinweis

Wenn Ihre Websiteportal-URL https://mcttraining.azurewebsites.net lautet, dann ist die URL-Struktur für die API-Signatur: https://mcttraining.azurewebsites.net/swagger

Warnung

(Im selben Browser) Sie müssen als Administrator*bei Ihrem Trainingsportal angemeldet sein, um auf den Swagger-Link für Ihre Instanz zugreifen zu können.

API-Authentifizierung

Benutzer*innen können sich für die Verwendung der Microsoft Community Training-APIs mit einer der folgenden Methoden authentifizieren.

Methode 1: Dienst-zu-Dienst-Authentifizierung

Um das Zugriffstoken programmgesteuert abzurufen, befolgen Sie die Anweisungen in diesem Dokument für eine Dienst-zu-Dienst-Authentifizierung.

Methode 2: Authentifizierung über Token

Um das Zugriffstoken manuell (zu Testzwecken) abzurufen, führen Sie die folgenden Schritte aus:

  1. Öffnen Sie den Browser.

  2. Öffnen Sie das Fenster „Überprüfen“. (Tastenkombination: Drücken Sie STRG + UMSCHALT + I, oder klicken Sie mit der rechten Maustaste, und wählen Sie „Überprüfen“ aus.)

  3. Gehen Sie im Fenster „Überprüfen“ zur Registerkarte „Netzwerk“.

  4. Rufen Sie nun im Browser die URL „https:// {Ihre-MCT-Portal-Domäne} /ExternalAuthentication/Login“ auf.

    Beispiel: Um ein Token für eine https://mctdemo2.azurefd.net-Instanz abzurufen, können wir „mctdemo2.azurefd.net/ExternalAuthentication/Login“ aufrufen.

  5. Geben Sie Ihre Anmeldeinformationen auf der Anmeldeseite ein. Klicken Sie auf „Anmelden“.

  6. Klicken Sie im Fenster „Überprüfen“ auf der Registerkarte „Netzwerk“ auf die Option „Rückruf“.

  7. Unter „Header“ wird die Kategorie „Ort“ angezeigt, die das Zugriffstoken (AccessToken) und das Aktualisierungstoken (RefreshToken) enthält.

    Token überprüfen

  8. Verwenden Sie das AccessToken, um die Rest-APIs aufzurufen (z. B. das Bearertoken AccessToken).

    Hinweis

    CURL-Beispielbefehl

    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. Wenn das AccessToken abläuft, verwenden Sie das RefreshToken, um ein neues AccessToken zu erhalten.

    Hinweis

    API-Signatur zum Abrufen des AccessToken mithilfe des RefreshToken

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

{identityprovider} = PHONE/EMAIL/AZUREAD

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

Warnung

Das „Aktualisierungstoken“ kann verwendet werden, um die Gültigkeit des AccessToken zu erhöhen. Das Ablaufdatum des RefreshToken hängt vom Authentifizierungstyp der Plattforminstanz ab.

Sobald das RefreshToken abläuft, müssen sich die Benutzer*innen explizit bei der Instanz anmelden, um ein neues AccessToken und ein neues RefreshToken zu erhalten (es sei denn, Sie verwenden die S2S-Authentifizierung).

Das AccessToken ist in der Regel 24 Stunden und das RefreshToken 90 Tage gültig.

Datenbankschema

Weitere Informationen zum Datenbankschema finden Sie in diesem Dokument.