Die REST API ermöglicht den Zugriff auf Funktionen und Daten eines WEBSALE Shop-Systems. Sie richtet sich an Entwickler, Integratoren und Dienstleister, die Prozesse automatisieren, Daten synchronisieren oder eigene Anwendungen anbinden möchten.

Übersicht der zur Verfügung stehenden API-Endpunkte

API Basics — Grundlagen zur Nutzung der REST API: Authentifizierung, Rechte, Abfrageparameter.
API-Referenz Anfragen — Verwaltung und Bearbeitung eingegangener Kundenanfragen.
API-Referenz Authentifizierung — Login über API-Schlüssel oder Benutzerkonto, Zugriffstoken, Token-Handling.
API-Referenz Benutzerverwaltung — Verwaltung von Benutzerkonten und Rechten im Admin-Interface.
API-Referenz Bestellungen — Abrufen, Aktualisieren und Löschen von Bestelldaten.
API-Referenz Bilder — Verwaltung von Produkt-, Kategoriebildern und weiteren Grafiken des Shops.
API-Referenz Blacklist — Pflege einer Ausschlussliste für E-Mail-Adressen.
API-Referenz CMS — Abruf der URL zum angebundenen Content-Management-System (Strapi).
API-Referenz Datenfeeds — Erstellung und Verwaltung von Produktdatenfeeds für externe Plattformen.
API-Referenz Gutscheine — Verwaltung von Gutscheinen und Gutscheinvorlagen.
API-Referenz Import — Steuerung und Überwachung von Datenimportvorgängen.
API-Referenz Kategorien — Erstellen, Abrufen und Zuordnen von Kategorien.
API-Referenz Key-Value-Store — Verwaltung von Einträgen im Redis-basierten Key-Value-Speicher.
API-Referenz Konfiguration — Zugriff auf globale und subshopspezifische Shop-Einstellungen.
API-Referenz Kundendaten — Verwaltung von Kundenkonten, Adressen und Zahlungsinformationen.
API-Referenz Log Manager — Abrufen und Filtern von Systemlogs nach Zeitpunkt, Subshop oder Schweregrad.
API-Referenz Meta-Daten — Verwaltung von Meta-Titeln und Beschreibungen für Seiten, Produkte und Kategorien.
API-Referenz Newsletter — Pflege von Abonnentenlisten und Zielgruppen.
API-Referenz Produkte — Erstellen, Abrufen, Aktualisieren und Löschen von Produkten und Lagerbeständen.
API-Referenz Produktbewertungen — Abrufen, Bearbeiten und Löschen von Produktbewertungen.
API-Referenz Reporter — Export von Datensätzen für bestimmte Shop-Bereiche (z. B. Bestellungen, Abonnenten).
API-Referenz SEO-URLs — Verwaltung und Generierung suchmaschinenfreundlicher URLs.
API-Referenz Sitemaps — Verwaltung und Generierung von XML-Sitemaps.
API-Referenz Statistiken — Abruf von statistischen Auswertungen zu Shop-Daten (z. B. Verkäufe, Anfragen).
API-Referenz Templatekompilierung — Auslösen und Überwachen von Kompilierungsvorgängen für Templates.
API-Referenz Textbausteine — Verwaltung sprachabhängiger Texte für die Template-Ausgabe.
API-Referenz Transaktionen — Abrufen und Verwalten von Zahlungsinformationen.
API-Referenz Videos — Verwaltung und Verlinkung von Videoinhalten im Shopsystem.

WEBSALE Dokumentation

Schnittstellen

Übersicht der zur Verfügung stehenden API-Endpunkte