Manuelle Konfiguration der REST-API

Avatar
Nerdio Product Support

Dieses Thema beschreibt, wie Sie die REST-API für die Verwendung mit Nerdio Manager manuell konfigurieren.

Standard-REST-API-Status in Nerdio Manager

Im Standardfall ist die REST-API deaktiviert, wenn Sie Nerdio Manager installieren.

Um den Status der REST-API zu überprüfen:

  1. Navigieren Sie in Nerdio Manager zu System > Einstellungen > Integrationen.

  2. Erweitern Sie den Bereich REST-API. Der Umschalter Aktueller Status zeigt an, ob die REST-API derzeit aktiviert oder deaktiviert ist.

Aktualisieren Sie das Nerdio-nmw-app-Manifest

Sie müssen die Nerdio-nmw-app-Manifestdatei mit den erforderlichen Informationen aktualisieren.

Anmerkung

Die folgenden Anweisungen beziehen sich auf die Nerdio-nmw-app-App-Registrierung, was der Standardname ist. Wenn Sie einen anderen Namen haben, finden Sie die Anwendungs-ID in Ihren Nerdio Manager App-Service-Umgebungsvariablen oder in der App-Konfiguration, falls Sie regionale Hochverfügbarkeit konfiguriert haben, indem Sie nach der Einstellung namens AzureAD:Client-ID suchen. Sie können diese ID verwenden, um die App-Registrierungsliste in Entra zu filtern und diese Anwendung zu bearbeiten.

So aktualisieren Sie das Nerdio-nmw-app-Manifest:

  1. Navigieren Sie im Azure-Portal zu App-Registrierungen.

  2. Suchen Sie nach Nerdio-nmw-app und wählen Sie es aus.

  3. Kopieren Sie im Abschnitt Übersicht den Wert der Anwendungs-ID (Client-ID).

  4. Wählen Sie im Blatt Verwalten die Option Manifest, um die JSON-Datei des Microsoft Graph-App-Manifests zu öffnen.

  5. Navigieren Sie zum Abschnitt api der Datei und fügen Sie die folgende Zeile hinzu:

    "identifierUris": ["api://<app_id>"],

  6. Ändern Sie den Wert von \"accessTokenAcceptedVersion\" von null auf 2.

    Sobald dies abgeschlossen ist,

    Anmerkung

    Ihre Manifest-Datei sollte wie folgt aussehen:

    image2061.png

  7. Speichern Sie die Manifest-Datei.

Fügen Sie einen Anwendungs-ID-URI hinzu

Wenn der Anwendungs-ID-URI nicht festgelegt ist, müssen Sie ihn hinzufügen.

Anmerkung

Ein Beispiel für einen Anwendungs-ID-URI ist api://g0cb288e-ff16-1861-9393-50219a19453c.

So fügen Sie einen Anwendungs-ID-URI hinzu:

  1. Navigieren Sie im Azure-Portal zu App-Registrierungen.

  2. Suchen Sie nach Nerdio-nmw-app und wählen Sie es aus.

  3. Wählen Sie Übersicht.

    image2053.png

  4. Wählen Sie Anwendungs-ID-URI hinzufügen.

    image2054.png

  5. Wählen Sie Hinzufügen und anschließend Speichern.

  6. Sobald diese Änderungen im Azure-Portal hinzugefügt und gespeichert wurden, navigieren Sie in Nerdio Manager zu System > Einstellungen > Integrationen.

  7. Wählen Sie im Bereich REST-API neben Anmeldedaten das Info-Symbol image2037.png.

    image2038.png

  8. Schließen Sie dieses Info-Pop-up und befolgen Sie die nachstehenden Schritte, um die REST-API-Konfiguration abzuschließen.

Erstellen Sie eine neue App-Registrierung.

Der nächste Schritt besteht darin, eine neue App-Registrierung im Azure-Portal zu erstellen und zu konfigurieren.

So erstellen Sie eine neue App-Registrierung:

  1. Navigieren Sie im Azure-Portal zu App-Registrierungen.

    image2039.png

  2. Wählen Sie + Neue Registrierung.

    image2055.png

  3. Geben Sie die folgenden Informationen ein:

    • Name: Geben Sie den Namen der neuen App-Registrierung ein.

    • Belassen Sie die Standardeinstellungen für die anderen Parameter.

  4. Sobald Sie die gewünschten Informationen eingegeben haben, wählen Sie Registrieren.

    Die Anwendung ist registriert und Sie werden zur Konfiguration Ihrer neu erstellten Anwendung weitergeleitet.

Aktualisieren Sie die neue App-Registrierung.

Der nächste Schritt besteht darin, die neue App-Registrierung zu aktualisieren.

So aktualisieren Sie die neue App-Registrierung:

  1. Navigieren Sie im Azure-Portal zu App-Registrierungen.

  2. Suchen Sie nach Nerdio-nmw-app und wählen Sie es aus.

  3. Wählen Sie im Blatt Verwalten die Option App-Rollen.

    image2062.png

  4. Kopieren Sie die RestClient-ID, dies ist die NME_ID, die wir benötigen.

  5. Navigieren Sie zurück zu App-Registrierungen.

  6. Wählen Sie die neu erstellte App-Registrierung aus (RESTApi in unserem Beispiel).

  7. Wählen Sie im Blatt Verwalten die Option Manifest aus.

    Tipp

    Bevor Sie Änderungen vornehmen, laden Sie eine Kopie des Manifests herunter, falls Sie Fehler machen sollten.

    image2056.png

  8. Suchen Sie die Abschnitts-Tags, die wie folgt aussehen sollten:

    image2042.png

  9. Fügen Sie innerhalb der Klammern Folgendes hinzu: \"NMW_REST_API_CLIENT:<app_id>\"

    Anmerkung

    Die geänderten Tags sollten wie folgt aussehen:

    image2041.png

  10. Suchen Sie \"requiredResourceAccess\", das vor jeglichen Änderungen wie folgt aussehen sollte:

    image2043.png

  11. Nehmen Sie die folgenden Änderungen vor:

    • resourceAppId: Dies ist die App_id, die wir im gesamten Dokument verwendet haben.

    • id: Ist die NME_ID, die Sie im vorherigen Schritt kopiert haben.

    • Type: Ändern Sie dies in Rolle.

  12. Speichern Sie die Manifest-Datei.

  13. Wählen Sie im Blatt Verwalten die Option API-Berechtigungen aus.

    image2066.png

  14. Erteilen Sie die Administratoreinwilligung.

  15. Wählen Sie im Blade Verwalten die Option Zertifikate &amp; Geheimnisse.

    image2064.png

  16. Wählen Sie + Neuer geheimer Clientschlüssel.

    image2047.png

  17. Geben Sie die folgenden Informationen ein:

    • Beschreibung: Geben Sie die Beschreibung des geheimen Clientschlüssels ein.

    • Dauer: Wählen Sie aus der Dropdown-Liste die gewünschte Dauer aus.

  18. Sobald Sie alle gewünschten Informationen eingegeben haben, wählen Sie Hinzufügen.

  19. Kopieren und speichern Sie den Wert des geheimen Clientschlüssels, der später benötigt wird.

    image2050.png

Überprüfen Sie den REST-API-Status in Nerdio Manager

Sobald Sie die oben genannten Schritte im Azure-Portal abgeschlossen haben, müssen Sie einige Minuten warten (wichtig), bevor Sie den REST-API-Status überprüfen in Nerdio Manager.

So überprüfen Sie den REST-API-Status:

  1. Aktualisieren Sie nach einer Wartezeit von einigen Minuten Ihre Sitzung in Nerdio Manager.

  2. Navigieren Sie zu System > Einstellungen > Integrationen.

    image2057.png

  3. Wählen Sie im Bereich REST-API neben Anmeldedaten die Option anzeigen.

    image2049.png

  4. Stellen Sie sicher, dass Ihre Anmeldedaten wie im obigen Beispiel aussehen.

  5. Wählen Sie OK, um das Anmeldedaten-Pop-up-Fenster zu schließen.

  6. Wählen Sie neben Dokumentation die Option swagger.

  7. Wählen Sie in der oberen rechten Ecke der Swagger-Seite Autorisieren.

    image2051.png

  8. Fügen Sie den Wert des geheimen Clientschlüssels ein, den Sie zuvor gespeichert haben.

  9. Wählen Sie Autorisieren.

PowerShell testen

Wir benötigen die folgenden Variablen, um die REST-API zu testen:

  • Client_Secret: Dies ist der geheime Clientschlüssel, den Sie zuvor gespeichert haben.

  • Client-ID: Dies kann aus den REST-API-Anmeldedaten kopiert werden.

  • Tenant_ID: Dies kann aus den REST-API-Anmeldedaten kopiert werden.

  • NME_Scope: Dies kann aus den REST-API-Anmeldedaten kopiert werden.

  • NME_URL: Dies ist der Link zur Nerdio Manager Web-App.

  • Sub_ID: Dies kann unter System > Einstellungen > Azure > Azure-Abonnements kopiert werden.

    image2058.png
So testen Sie ein PowerShell-Skript:

  1. Erstellen und speichern Sie ein PowerShell-Skript mit den folgenden Befehlen unter Verwendung der Variablen, die Sie gerade kopiert haben. In diesem Beispiel speichern wir REST-API.ps1.

    Tipp

    # NerdioManager PowerShell-Modul installieren

    Install-Module -Name NerdioManagerPowerShell

    # Einige Variablen einrichten

    # Client_Secret ist das Geheimnis, das Sie für die neue App-Registrierung erstellt haben

    $NMEClientSecret = "<Client_Secret>"

    # Client_ID kann aus den NME Rest API-Anmeldeinformationen kopiert werden

    $NMEClientId = "Client_ID"

    # Tenant_ID kann aus den NME Rest API-Anmeldeinformationen kopiert werden

    $NMETenantId = "<Tenant_ID>"

    # NME_Scope kann aus den NME Rest API-Anmeldeinformationen kopiert werden

    $NMEScope = "<NME_Scope>"

    # NME_URL ist der Link zur NME-Web-App

    $nMEuRI = "<NME_URL>"

    # Sub_ID kann unter System > Einstellungen > Azure kopiert werden

    $NMWSubscriptionId = "<Sub_ID>"

    # Verbinden

    Connect-NME -ClientId $NmeClientId -ClientSecret $NmeClientSecret -TenantId $NmeTenantId -ApiScope $NmeScope -NmeUri $NmeUri

    # Verfügbare Workspaces auflisten

    Get-nmeworkspace

  2. Öffnen Sie PowerShell mit erhöhten Berechtigungen und navigieren Sie zu dem Speicherort des Skripts REST-API.ps1.

  3. Führen Sie die folgenden Befehle aus:

    Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser

    .\REST-API.ps1

  4. Wählen Sie bei der entsprechenden Aufforderung Ja oder Ja, alle aus.

  5. Bestätigen Sie, dass Sie die Liste der verfügbaren Workspaces sehen können.

    image2059.png

Postman

Weitere Informationen finden Sie unter REST API Endpoint Implementation.

War dieser Beitrag hilfreich?

1 von 1 fanden dies hilfreich
Haben Sie Fragen? Anfrage einreichen

Verwandte Beiträge

Kommentare (0 Kommentare)

Zu diesem Beitrag können keine Kommentare hinterlassen werden.