Einrichtungshandbuch für die benutzerdefinierte Joomla-API-Erweiterung
Übersicht
Das Joomla Custom API-Erweiterung Ermöglicht die Erstellung benutzerdefinierter APIs zur Erweiterung der Funktionen des Joomla CMS (Content-Management-Systems). Mithilfe dieser APIs können Sie bestimmte Funktionen oder Daten Ihrer Joomla-Website offenlegen, wodurch externe Programme oder Dienste mit Ihrer Joomla-Website kommunizieren können. Mithilfe der von Ihnen entwickelten benutzerdefinierten Endpunkte bietet dieses Plugin eine reibungslose Methode für die Arbeit mit der Joomla-Datenbank und ermöglicht Ihnen die einfache Durchführung CRUD (Erstellen, Lesen, Aktualisieren und Löschen) Operationen.
Schritt 1: Installation der benutzerdefinierten API-Erweiterung
- Laden Sie die ZIP-Datei herunter miniOrange Custom API-Erweiterung für Joomla über den obigen Link.
- Melden Sie sich bei Ihrer Joomla-Site an Administrator Konsole.
- Klicken Sie im linken Umschaltmenü auf System, dann unter Installieren Abschnitt klicken Sie auf Erweiterungsoptionen.
- Hier klicken Sie auf Nach Datei suchen Schaltfläche, um die zuvor heruntergeladene Erweiterungsdatei zu suchen und zu installieren.
- Sobald die Installation des Plugins erfolgreich ist. Klicken Sie nun auf Beginnen Sie mit der Verwendung des Joomla Custom API-Plugins.
Hinweis: Diese Anleitung enthält Konfigurationsschritte für die kostenlose und die Premium-Version der Joomla Custom API-Erweiterung. Sofern eine Funktion in der kostenlosen Version verfügbar ist, werden die Schritte anhand der Benutzeroberfläche der kostenlosen Version demonstriert. Für Funktionen, die exklusiv in der Premium-Version verfügbar sind, werden die entsprechenden Schritte gezeigt. Sie werden möglicherweise geringfügige Unterschiede in der Benutzeroberfläche zwischen der kostenlosen und der Premium-Version feststellen, der Einrichtungsprozess bleibt jedoch im Wesentlichen gleich.
Schritt 2: Erstellen Sie benutzerdefinierte APIs
- STARTE
- jetzt lesen [PRÄMIE]
- SETZEN [PRÄMIE]
- LÖSCHEN [PRÄMIE]
Schritt 3: API-Authentifizierung konfigurieren [PRÄMIE]
- Inhaber-Token
- JWT-Authentifizierung
- Basic Authentication
- API-Schlüssel
Schritt 4: Authentifizierung für REST-APIs [PRÄMIE]
Konfigurieren Sie die Authentifizierung für die Kern-APIs von Joomla und die auf Ihrer Joomla-Site gehosteten APIs, die automatisch angewendet wird, wenn diese APIs aufgerufen werden.
- Gehen Sie zur REST API-Authentifizierung Tab.
- Geben Sie die API-Name und API-Endpunkt in den angegebenen Feldern.
- Dann wählen Sie die HTTP-Methode Aus dem Dropdown-Menü.
- Schalten Sie dann die Aktivieren Sie die Authentifizierung und wählen Sie die gewünschte Authentifizierungsmethode aus. Weitere Informationen finden Sie im Schritt 3: Im Abschnitt des Handbuchs erfahren Sie, wie Sie die verschiedenen Authentifizierungsmethoden konfigurieren.
Schritt 5: Externe APIs konfigurieren [PRÄMIE]
- Gehen Sie zur Externe APIs Tab.
- Geben Sie den API-Namen ein.
- Dann wählen Sie die API-Methode aus dem Dropdown.
- Geben Sie die Externe API im angegebenen Feld.
- Sie können Abfrageparameter übergeben, die für diese konfigurierte API erforderlich sind. Damit die Daten im Abfrageparameterformat gesendet werden können.
- Es gibt zwei Textfelder – das erste dient zur Eingabe des Schlüssels und das zweite zur Eingabe des Werts.
- Beispiel: Wenn Sie den folgenden Abfrageparameter „Benutzername→Testbenutzer“ übergeben müssen, müssen Sie den „Benutzernamen“ in den Schlüssel und „Testbenutzer“ in das Feld „Wert“ einfügen.
- Sie können mit der Schaltfläche + mehrere Parameter hinzufügen.
- In den Headern gibt es zwei Textfelder – das linke für den Header-Namen und das rechte für den zu übergebenden Header-Wert. Beispiel: Wenn der übergebene Header das Format „Autorisierung:Träger“ hat, wird „Autorisierung“ in das erste Textfeld eingefügt und „Träger“ in das rechte Textfeld, wie in der folgenden Abbildung dargestellt.
- Wenn der API-Anbieter erwartet, dass die Daten im Text der API-Endpunktanforderung gesendet werden müssen, können Sie die erforderlichen Details eingeben. Es stehen zwei Formate zum Senden der Daten zur Verfügung: x-www-form-urlencoded und JSON.
- Für die zu sendenden Daten in den Body-Parametern im Format x-www-form-urlencoded.
- Es gibt zwei Textfelder – das erste dient zur Eingabe des Schlüssels und das zweite zur Eingabe des Werts.
- Beispiel: Wenn Sie den folgenden Body-Parameter „Benutzername→Testbenutzer“ übergeben müssen, müssen Sie den „Benutzernamen“ in das Schlüsselfeld und „Testbenutzer“ in das Wertefeld einfügen.
- Für die mehreren Schlüssel-Wert-Paare, die im Anforderungstext der API-Endpunktanforderung übergeben werden müssen, können Sie auf die Schaltfläche + klicken.
- Damit die Daten in den Body-Parametern im JSON-Format gesendet werden: Sie müssen das JSON aus der Dropdown-Liste auswählen, die dem Request Body entspricht
- Klicken Sie nun auf die Konfiguration speichern .
Schritt 6: Joomla Core REST-APIs konfigurieren [PRÄMIE]
- Navigieren Sie zu der Joomla Core REST-APIs und klicken Sie auf Neue API konfigurieren .
- Um die Joomla Core REST-API zu konfigurieren, benötigen Sie ein API-Authentifizierungstoken. Gehen Sie zu Benutzer -> Verwalten -> Klicken Sie auf einen Benutzer.
- Hier geht es zum Joomla API-Token Tab und kopieren Sie die Zeichen.
- Gehe zurück zum Joomla Core REST-API Drücken Sie die Tabulatortaste und fügen Sie das generierte Token in das entsprechende Feld ein. Geben Sie einen Namen für diese Konfiguration ein und wählen Sie dann die erforderlichen Optionen aus. Endpunkt aus dem Dropdown-Menü. Bei Bedarf können Sie auch Folgendes anwenden: Abfragefilter und konfigurieren Sie die Endpunktfelder zusammen mit der bevorzugten AusgabeformatSobald alles eingestellt ist, klicken Sie auf die Schaltfläche Test-API Schaltfläche zum Überprüfen der Konfiguration.
- Sie werden eine sehen API-Antwort Wenn die Konfiguration erfolgreich war, klicken Sie dann auf die Konfiguration speichern .
- Ihre Joomla Core REST-API Die Konfiguration war erfolgreich. Sie können nun die generierte Datei kopieren. Kurzwahlnummern Sie können den Code aus diesem Abschnitt an beliebiger Stelle auf Ihrer Website einfügen, um die API-Antwort direkt im Frontend anzuzeigen.
