Einrichtungshandbuch für die benutzerdefinierte Joomla-API-Erweiterung
Übersicht
Die Benutzerdefinierte API-Erweiterung ermöglicht die Erstellung benutzerdefinierter APIs, um die Funktionen des Joomla CMS (Content Management System) zu erweitern. Mit diesen 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 demonstriert die Konfigurationsschritte anhand der Premium-Version der Joomla Custom API-Erweiterung. Die gleichen Schritte können auch für die kostenlosen Version, obwohl Sie möglicherweise leichte Unterschiede in der Benutzeroberfläche (UI) oder den verfügbaren Optionen feststellen. Der allgemeine Einrichtungsprozess bleibt derselbe.
Schritt 2: Erstellen Sie benutzerdefinierte APIs
- STARTE
- jetzt lesen
- SETZEN
- LÖSCHEN
Schritt 3: API-Authentifizierung konfigurieren
- Inhaber-Token
- JWT-Authentifizierung
- Basic Authentication
- API-Schlüssel
Schritt 4: Authentifizierung für REST-APIs
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 zum REST API-Authentifizierung Tab.
- Geben Sie die API-Name mit einem 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
- Gehen Sie zum 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 .
