Use this file to discover all available pages before exploring further.
Mit dem Endpunkt seo/texts/ steht Ihnen eine Schnittstelle zur Verfügung, mit der Sie SEO-Meta-Daten für verschiedene Bereiche des Shops (z. B. Seiten, Kategorien, Produkte) verwalten können. Die API ermöglicht es, Meta-Titel und Meta-Beschreibungen manuell zu pflegen oder sie bei Bedarf auf die automatisch generierten Standardwerte zurückzusetzen.Meta-Daten werden dabei entweder direkt gesetzt oder auf Basis hinterlegter Schemata erzeugt.
Meta-Daten von Kategorie- und Produkt-Seiten werden in benutzerdefinierten Feldern metaTitle und metaDescription gespeichert. Um damit zu arbeiten, werden Endpunkte categories/ und products/ verwendet. Meta-Daten der Start-Seite befinden sich in subshop-spezifischen Konfigurationen und können über API nicht abgefragt werden. Für Meta-Daten der sonstigen Shop-Seiten gibt es eine Tabelle in der Datenbank.
In diesem Abschnitt finden Sie alle Endpunkte zur Verwaltung von Meta-Daten für Shop-Seiten, die intern als Views bezeichnet werden. Sie können Meta-Daten wie Titel und Beschreibung aktualisieren oder zurücksetzen, Daten der vorhandenen Seiten abrufen, neue Seiten registrieren sowie einzelne Einträge löschen.Die Views werden über ihre resourceId eindeutig identifiziert.Rechte für SEO-Daten sind erforderlich.
Diese Methode liefert eine paginierte Liste von Meta-Daten (z. B. Titel und Beschreibung) aller im Shop vorhandenen Seitenressourcen, die für SEO-Zwecke gepflegt werden können. Mithilfe der Filter- und Sortierparameter lassen sich gezielt nur bestimmte Einträge laden – etwa nur Seiten mit manuell gesetzten Meta-Titeln oder -Beschreibungen.Die Anzahl der Einträge pro Seite kann mit dem Parameter size im Bereich von 1 bis 300 festgelegt werden.Zur Nutzung sind Leserechte für SEO-Daten erforderlich.
Mit dieser Methode kann eine neue Shop-Seite zur SEO-Verwaltung registriert werden.Beim Anlegen werden metaTitle und metaDescription zunächst leer gespeichert. Es muss ein eindeutiger Seitenname (viewName) übergeben werden, der als resourceId dienen wird. Der Name darf noch nicht existieren.Für diese Aktion sind Erstellrechte für SEO-Daten erforderlich.Hinweis: Wenn eine neue Shop-Seite nicht manuell registriert wird, werden für sie Meta-Daten automatisch nach dem Schema aus der Konfiguration generiert, wenn auf sie zum ersten Mal zugegriffen wird.
Mit dieser Methode können die SEO-Meta-Daten (Titel und Beschreibung) einer bestimmten Shop-Seite gezielt aktualisiert werden. Es dürfen ausschließlich metaTitle und/oder metaDescription verändert werden – begleitende technische Felder wie metaTitleSetManually, metaDescriptionSetManually und updatedAt werden automatisch gesetzt.Die Angabe der viewId in der URL ist erforderlich. Es handelt sich dabei um die numerische id des Datensatzes (nicht die resourceId).Zum Aktualisieren müssen entsprechende Schreibrechte für SEO-Daten vorhanden sein.
{ "createdAt": "2025-01-09 11:07:55", "id": 5, "metaDescription": "Informieren Sie sich hier über die Allgemeinen Geschäftsbedingungen (AGB)", "metaDescriptionSetManually": true, "metaTitle": "My page", "metaTitleSetManually": true, "resourceId": "agb", "updatedAt": "2025-03-06 16:10:42"}
Dieser Endpunkt setzt die manuell gesetzten Meta-Daten ausgewählter Seiten zurück und ersetzt sie durch automatisch generierte Werte gemäß dem festgelegten Schema. Die Felder metaTitleSetManually und metaDescriptionSetManually werden dabei auf false gesetzt.Schreibrechte für SEO-Daten sind erforderlich.
Mit diesem Endpunkt lassen sich die Meta-Daten (Titel und Beschreibung) einer registrierten Seite gezielt löschen. Die Seite wird anhand ihrer numerischen id identifiziert.Für die Ausführung sind Löschrechte für SEO-Daten erforderlich.
Dieser Abschnitt behandelt die Verarbeitung von SEO-Meta-Daten für Kategorien. Die API erlaubt ausschließlich das Zurücksetzen manuell gepflegter Meta-Titeln und Meta-Beschreibungen.Dabei werden bestehende Inhalte entfernt und durch Werte ersetzt, die anhand eines Schemas generiert werden.
Setzt die Meta-Daten der übergebenen Kategorien zurück. Manuell gesetzte Felder metaTitle und metaDescription werden durch automatisch generierte Inhalte ersetzt. Die Felder metaTitleSetManually und metaDescriptionSetManually werden dabei auf false gesetzt.Schreibrechte für SEO-Daten sind erforderlich.
Für Produkte steht ebenfalls nur eine Reset-Option zur Verfügung. Die API bietet keine Möglichkeit, einzelne SEO-Felder direkt zu aktualisieren. Stattdessen werden manuelle Meta-Angaben vollständig durch automatisch generierte Daten ersetzt.
Dieser Endpunkt löscht die manuell eingetragenen Meta-Daten von Produkten und ersetzt sie durch generierte Inhalte. Die Felder metaTitleSetManually und metaDescriptionSetManually werden dabei auf false gesetzt.Schreibrechte für SEO-Daten sind erforderlich.
Dieser Endpunkt löst eine Aktualisierung aller SEO-Texte des Shops aus. Dabei werden Meta-Titel und Meta-Beschreibungen, die nicht manuell gesetzt wurden, anhand des konfigurierten Schemas neu generiert.Schreibrechte für SEO-Daten sind erforderlich.
Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum KundenportalBitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.
