Erstellen Sie externe REST-API-Endpunkte in Dotnetnuke (DNN).
Übersicht
Das DNN REST API-Plugin ermöglicht die reibungslose Integration externer APIs in DNN-Sites und ermöglicht Abruf- und Aktualisierungsvorgänge für externe Daten über API-Aufrufe. Dieses Plugin ermöglicht das Abrufen oder Aktualisieren externer Daten während verschiedener DNN-Ereignisse oder -Vorgänge, wie z. B. Benutzeranmeldung, Benutzerregistrierung usw. Diese Anleitung führt Sie Schritt für Schritt zur Einrichtung der externen REST API für DNN-Sites.
Voraussetzungen: Download und Installation
- Um externe 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 externen 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.
- 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 externe APIs
- Navigieren Sie zu der DNN-REST-API-Einstellungen Tab. Hier sehen Sie die Dashboard des DNN REST API-Plugins.
- Klicken Sie auf API erstellen, um die externe API-Generierung zu initiieren.
- Jetzt auswählen Externe 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.
- Externer API-Endpunkt: Konfigurieren Sie Ihren externen API-Endpunkt.
- Sie können die Authentifizierungsmethode für die API auf der Registerkarte „Autorisierung“ konfigurieren und bei Bedarf Header auf der Registerkarte „Header“ hinzufügen.
- Sie können die Daten im Textkörper auch in verschiedenen Formaten übergeben, darunter JSON, x-www-form-urlencoded, xml usw. über die Registerkarte „Textkörper“.
- Im Abschnitt „Erweiterte Einstellungen“ haben Sie die Möglichkeit, die Parameter zu übergeben.
- Klicken Sie nach der Eingabe der Daten auf API generieren.
- Jetzt finden Sie im Abschnitt „Externe APIs“ Ihre generierte API.
3. Testen Sie externe APIs
- Um die API zu testen, klicken Sie auf das Test Option unter dem Action Dropdown-Liste.
- Ein Test-Popup wird angezeigt. Geben Sie die erforderlichen Details wie Überschriften oder Textdaten ein und klicken Sie dann auf Ausführen .
- Wenn alles richtig konfiguriert ist, gibt die API eine Erfolgsantwort zurück, die bestätigt, dass Ihre externe API richtig konfiguriert ist.
Diese Anleitung hilft Ihnen beim Einrichten und Integrieren Ihrer externen APIs in Ihre DNN-Anwendung. Durch die Nutzung dieser REST-API-Integration mit DNN können Sie über API-Aufrufe aus Ihrer DNN-Anwendung sicher Abruf-, Einfüge-, Aktualisierungs- und Löschvorgänge an den externen Daten durchführen.
