Beschreibung
ContentApi ist die REST-Schnittstelle für OXID eShop 6 ab Version 6.1 und OXID eShop 7 ab Version 7.1. Terminal- und KI-Clients lesen und schreiben damit die Inhalte Ihres Shops: Artikel, Kategorien, CMS-Seiten, Bilder und Nachrichtenbeiträge von EcsDesk, sobald das Nachrichten-Plugin verbunden ist. Kunden- und Bestelldaten gibt die Schnittstelle nicht heraus.
Handbuch Übersicht Installationsservice
Shop-Inhalte aus dem Client pflegen
Sie formulieren den Auftrag auf Deutsch. Der Client sucht die Datensätze und schreibt die freigegebenen Änderungen in den Shop. Die Anmeldung läuft über eine Browser-Freigabe nach dem OAuth-2.0-Device-Authorization-Verfahren. Benutzername und Passwort geben Sie nur auf der HTTPS-Seite Ihres Shops ein. Zugang erhalten nur Administratorkonten, die Sie in den Moduleinstellungen eintragen. Lesen ist immer möglich. Schreiben schalten Sie für Artikel, Langbeschreibungen, Kategorien, CMS-Seiten, Bilder, Nachrichten und den Cache jeweils einzeln frei.
Was sich bearbeiten lässt
- Artikel mit Titel, Kurz- und Langtext, Suchbegriffen, SEO, Preis, Maßen, Hersteller, Lieferant, Kategorien, Attributen, Zubehör und Cross-Selling
- Varianten mit eigener Artikelnummer, Auswahl und Preis. Erbbare Texte bleiben am Vaterartikel
- Kategorien mit Texten, SEO, Sortierung, Sichtbarkeit und gezielter Artikelzuordnung
- CMS-Seiten mit Titel, Inhalt und SEO in den Shopsprachen
- Artikel- und Kategoriebilder sowie Bilder in Langtexten und CMS-Seiten, sobald Sie Uploads freischalten
- EcsDesk Nachrichten und EcsDesk Newsletter, wenn das Nachrichten-Plugin verbunden ist
Lagerbestände bleiben bei Inhaltsänderungen erhalten und lassen sich getrennt korrigieren.
Für wen ist ContentApi geeignet?
- Shops, in denen Texte, Kategorien und CMS-Seiten laufend gepflegt werden
- Betreiber, die diese Pflege aus einem Desktop- oder Terminal-Client erledigen
- OXID eShop 6 und 7, bei denen die Schreibrechte je Inhalt selbst gesetzt werden
Voraussetzungen und Lieferumfang
- OXID eShop 6 ab Version 6.1 mit Smarty sowie OXID eShop 7 ab Version 7.1 mit Twig. Die Pakete sind je Hauptversion getrennt und nicht austauschbar
- Unverschlüsselter Quelltext
- Deutsches Handbuch
Beim Kauf wählen Sie das Paket für OXID 6 oder OXID 7. Die Installation bieten wir zum Festpreis an: Modul-Installation Service. Sie können das Modul auch selbst oder über Ihre Agentur installieren.
Häufige Fragen
Für welche Shopversionen eignet sich ContentApi?
Für OXID eShop 6 ab Version 6.1 mit Smarty und für OXID eShop 7 ab Version 7.1 mit Twig. Die Pakete sind je Hauptversion getrennt und nicht austauschbar.
Kommen Kunden- oder Bestelldaten in die Schnittstelle?
Nein. ContentApi stellt Artikel, Kategorien, CMS-Seiten, Bilder und auf Wunsch Nachrichtenbeiträge bereit.
Wo gebe ich das Passwort ein?
Nur auf der Freigabeseite Ihres Shops im Browser. Nach Ihrer Bestätigung erhält der Client einen zeitlich begrenzten Zugriff.
Muss ich die Schnittstelle selbst programmieren?
Nein. Sie schreiben den Auftrag in normaler Sprache. Der Client spricht die dokumentierte REST-Schnittstelle.