ContentApi
Bemerkung
Modul-ID: ecs_contentapi
In der OXID-Modulliste wird das Modul unter dem technischen Titel „eComStyle.de: ContentApi“ geführt.
Verfügbar für OXID eShop 6 ab Version 6.1 und alle folgenden OXID-6-Versionen sowie für OXID eShop 7 ab Version 7.1 und alle folgenden OXID-7-Versionen. OXID 6 verwendet das Smarty-Paket, OXID 7 das Twig-Paket. Die Pakete sind nicht austauschbar.
ContentApi stellt eine REST-Schnittstelle für Artikel, Kategorien, CMS-Seiten, Bilder und Blog-Beiträge bereit. So lassen sich Shop-Inhalte aus Terminal- und KI-Clients lesen und – bei Freigabe – auch schreiben, etwa für Textpflege, Kategoriezuordnungen oder Content-Aktualisierungen.
Der Zugang läuft über eine sichere Browser-Freigabe: Zugangsdaten werden nicht im KI-Client hinterlegt, sondern persönlich auf einer HTTPS-geschützten Freigabeseite bestätigt. Der Zugriff ist auf freigegebene Administratorkonten beschränkt.
Bereich |
Funktion |
Wirkung |
|---|---|---|
REST-API |
Schnittstelle für Artikel, Kategorien, CMS-Seiten, Bilder und Blog-Beiträge. |
KI- und Terminal-Clients können Shop-Inhalte lesen und je nach Freigabe ändern. |
Sichere Freigabe |
Anmeldung über eine Browser-Freigabeseite nach dem OAuth-2.0-Device-Authorization-Verfahren. |
Benutzername und Passwort werden nicht an den KI-Client übermittelt. |
Getrennte Zugriffsrechte |
Lesen grundsätzlich möglich; Schreiben je Bereich in den Moduleinstellungen freischaltbar. |
Volle Kontrolle, welche Bereiche verändert werden dürfen. |
Admin-Freigabe |
Nur ausdrücklich eingetragene Administratorkonten erhalten Zugang. |
Ohne Eintrag ist die API vollständig gesperrt. |
Bild-Uploads |
Optionale, ressourcenspezifische Upload-Endpunkte für Artikelbilder. |
Standardmäßig deaktiviert und separat freischaltbar. |
Wählen Sie Ihren Bereich
Installation für Agenturen
Paketauswahl für OXID 6 und 7, Voraussetzungen, manuelle Installation, Aktivierung, Update und Datenaufbewahrung.
Bedienung für Shop-Betreiber
Schnellstart, Verbindung mit dem KI-Client, alle Moduleinstellungen, täglicher Arbeitsablauf sowie Sicherheits- und Prüfhinweise.
Warnung
Die API erlaubt bei Freigabe Schreibzugriffe auf Shop-Inhalte. Vergeben Sie Zugänge nur an vertrauenswürdige Administratorkonten, beschränken Sie Schreibrechte auf die benötigten Bereiche und testen Sie die Freigaben vor dem produktiven Einsatz.