Erstellen Sie benutzerdefinierte REST-API-Endpunkte in Dotnetnuke (DNN).

Übersicht

Das DNN REST API-Plugin ermöglicht die Erstellung benutzerdefinierter API-Endpunkte innerhalb der DNN-Plattform und ermöglicht so die Interaktion externer Systeme mit DNN-Funktionen. Sie können Ihre benutzerdefinierten API-Endpunkte einfach konfigurieren, um spezifische Anforderungen zu erfüllen, und dabei alle HTTP-Methoden nutzen. Dieses Benutzerhandbuch bietet umfassende Dokumentation zum Einrichten und Testen benutzerdefinierter APIs.

Download Plugin

Tarifpläne

Voraussetzungen: Download und Installation

Um benutzerdefinierte APIs für die DNN REST API zu konfigurieren, müssen Sie die miniOrange DNN REST API-Authentifizierungs-Plugin aus dem DNN-Store.
Laden Sie das Installationspaket hoch, indem Sie zu Einstellungen > Erweiterung > Erweiterung installieren.

Konfigurationsschritte

Schritt-für-Schritt-Anleitung zur benutzerdefinierten DNN-API-Authentifizierung.

1. Modul auf der DNN-Seite hinzufügen

Öffnen Sie eine beliebige Seite auf Ihrer DNN-Site (Bearbeiten-Modus) und klicken Sie auf Modul hinzufügen.

DNN Custom API – Klicken Sie auf „Modul hinzufügen“

Suchen Sie nach DNN-REST-API und klicken Sie auf die DNN REST API. Ziehen Sie das Modul per Drag & Drop auf die gewünschte Seite.

Sie haben die Installation des DNN REST API-Moduls auf Ihrer DNN-Site abgeschlossen.

2. Erstellen Sie benutzerdefinierte APIs

Navigieren Sie zu der Registerkarte „DNN REST API-Einstellungen“. Hier sehen Sie die Dashboard des DNN REST API-Authentifizierungs-Plugins.

Klicken Sie auf API erstellen, um die benutzerdefinierte API-Generierung zu starten.

Wählen Sie den API-Typ als Benutzerdefinierte API.

DNN Custom API – Wählen Sie eine benutzerdefinierte API

Geben Sie die folgenden Details ein:

API-Name: Geben Sie Ihrer API einen eindeutigen Namen.
API-Methode: Auswählen HTTP-Anforderungsmethode aus dem Dropdown.
Tabellenname: Geben Sie die Tabelle an, auf die Sie zugreifen möchten.
Antwortspalte: Wählen Sie Spalten aus, für die Sie Operationen durchführen möchten.
Authentifizierung konfigurieren (optional): Auf der Registerkarte „Erweiterte Einstellungen“ finden Sie eine Option zum Auswählen der Authentifizierungsmethoden für die API, darunter API-Schlüssel, Basisauthentifizierung, JWT usw., und zum Zuordnen der für die jeweilige Methode erstellten Authentifizierungs-App.
Filter anwenden (optional): Sie können Bedingungen auf die Spalten anwenden, die Ihnen basierend auf den angewendeten Filtern Zugriff auf bestimmte Datensätze ermöglichen.
Um es zu konfigurieren, können Sie die Spalte aus der Dropdown-Liste „Bedingungsspalte“ auswählen und dann die Bedingung und den URL-Parameter auswählen, auf die Sie die Bedingung anwenden möchten.

Benutzerdefinierte DNN-API – Geben Sie die API-Details ein

Klicken Sie auf API generieren.

Jetzt unter der Benutzerdefinierte APIs Im Abschnitt „API erstellen“ finden Sie die von Ihnen erstellte API.

DNN Custom API – Liste der benutzerdefinierten APIs

3. Testen Sie die generierten APIs

Um die API zu testen, klicken Sie auf das Test Option unter dem Action Dropdown-Liste.

DNN Custom API – Testen Sie die benutzerdefinierte API

Es erscheint ein Test-Popup mit Ihrem API-Endpunkt und der konfigurierten HTTP-Methode. Sie können die Parameter in den Headern oder die Daten bei Bedarf im Body übergeben. Klicken Sie anschließend auf Ausführen.

DNN Custom API – Klicken Sie auf „Ausführen“

Wenn alles richtig konfiguriert ist, wird eine erfolgreiche Antwort angezeigt, die bestätigt, dass Ihre API wie erwartet funktioniert.

DNN REST API – Testen Sie die erfolgreiche Antwort

Sie können die Beispielanforderungs- und -antwortformate für Ihre API-Anforderung im Test-Popup-Fenster abrufen.

Mit diesem Handbuch können Sie Erstellen Sie benutzerdefinierte REST-APIs für Ihre DNN-Site. Mit dem DNN REST API-Plugin können Sie DNN REST APIs sicher konfigurieren, testen und verwalten.

Inhalte