Zum Hauptinhalt springen

Phase 1: Backend-Konfiguration (OAuth1-API)

Dieser Schritt ermöglicht Kleep den Zugriff auf Ihren Produktkatalog, die Bestellhistorie und die Retouren-Daten zur Kalibrierung des Algorithmus.

1. OAuth1-Integration erstellen

  1. Melden Sie sich in Ihrem Magento-Admin-Panel an.
  2. Navigieren Sie zu System > Integrationen.
  3. Klicken Sie auf „Neue Integration hinzufügen”.
  4. Füllen Sie das Feld Name aus (z. B. „Kleep Integration”).
  5. Geben Sie Ihr Admin-Passwort zur Bestätigung ein.

2. API-Berechtigungen konfigurieren

RoutenDetails
/products/*Zugriff auf alle Produktressourcen
/categories/*Zugriff auf alle Kategorieressourcen
/orders/*Zugriff auf alle Bestellressourcen
/returns/*Zugriff auf alle Retouren-Ressourcen
/returnsAttributeMetadata/*Zugriff auf alle Retouren-Attributressourcen
/returnsItemAttributeMetadata/*Zugriff auf alle Retouren-Artikel-Attributressourcen
/creditmemos/*Zugriff auf alle Gutschrift-Ressourcen
/creditmemo/*Zugriff auf einzelne Gutschrift-Ressourcen
/stockItems/*Zugriff auf alle Lagerressourcen
/store/*Zugriff auf alle Shop-Ressourcen
/inventory/*Zugriff auf alle Inventarressourcen
/customers/*Zugriff auf alle Kundenressourcen
Dies sollte den folgenden ACLs in Magento entsprechen:
  • Magento_Catalog::products
  • Magento_Catalog::categories
  • Magento_Sales::sales
  • Magento_Sales::creditmemo
  • Magento_Sales::actions_view
  • Magento_Rma::rma
  • Magento_Rma::magento_rma
  • Magento_Rma::rma_attributes
  • Vendor_Module::returns
  • Magento_CatalogInventory::cataloginventory
  • Magento_Store::store
  • Magento_Config::config
  • Magento_Inventory::inventory
  • Magento_Customer::customer
⚠️ Wichtig:
  • Wenn Ihre Magento-Instanz zusätzliche API-Schichten oder benutzerdefinierte Endpunkte bereitstellt (z. B. benutzerdefinierte Retouren-/RMA-APIs), stimmen Sie sich bitte mit uns ab.
  • Wenn Sie einen externen Retouren-Anbieter ohne Integration über die Magento-API verwenden, lesen Sie bitte die Dokumentation zu Retouren-Daten oder koordinieren Sie sich mit uns, um die passende Integrationsmethode auszuwählen.

3. Zugangsdaten aktivieren und abrufen

  1. Klicken Sie auf „Speichern”, um die Integration zu erstellen.
  2. Klicken Sie auf „Aktivieren” bei der neu erstellten Integration.
  3. Ein Pop-up zeigt Ihre OAuth-Zugangsdaten:
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret
  4. Kopieren Sie diese Zugangsdaten – Sie müssen sie an Ihren Kleep-Ansprechpartner senden.
Anleitungen zum Erstellen und Abrufen von Magento 2-API-Zugangsdaten finden Sie unter:
Subscribe Pro-Tutorial: Magento 2-API-Zugangsdaten erstellen und abrufen Offizielles Adobe-Tutorial: Magento 2 OAuth-Authentifizierung

4. Zugangsdaten an Kleep senden

Bitte senden Sie Ihrem Kleep-Ansprechpartner folgende Informationen per E-Mail:
  1. Geben Sie bitte die vollständige API-Basis-URL(s) für den/die Shop(s) an.
  2. OAuth1-Zugangsdaten
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret

Phase 2: Frontend-Integration (Widget)

Dieser Schritt umfasst das Hinzufügen des Kleep-Skripts zu Ihren Produktseiten (PDP). Kompatibel mit allen Magento-Versionen. Folgen Sie unserem JS-Bibliotheks-Widget-Leitfaden, um den Frontend-CTA auf Ihren Produktseiten zu installieren und zu konfigurieren.

Phase 3: Verwaltung fehlender Daten (SFTP)

Dieser Abschnitt gilt, wenn Daten nicht über Standard-API-Endpunkte abgerufen werden können. Wenn Ihre Magento-API den Abruf von Retouren oder bestimmten spezifischen Daten nicht erlaubt, erfolgt der Austausch über CSV-Dateien. Bitte lesen Sie die nachstehende Dokumentation. Dieser Leitfaden führt Sie Schritt für Schritt durch den Prozess der Übermittlung fehlender Daten:

Phase 4: Validierung & Produktionsbereitstellung

1. Testumgebung

Stellen Sie zuerst in Ihrer Vorproduktions-/Staging-Umgebung bereit.

2. Visuelle Validierung

Überprüfen Sie vor dem Go-Live folgendes:
  • Wird die Schaltfläche korrekt angezeigt?
  • Öffnet ein Klick das Pop-up (Drawer)?
  • Keine „CORS”-Fehler in der Browser-Konsole?

3. Go-Live

Nach der Validierung durch Sie und das Kleep-Team stellen Sie die Änderungen in Ihrem Produktions-Theme bereit.---

Cookies & Datenschutz

Kleep wird vollständig durch die Besuchereinwilligung gesteuert: Das Skript wird erst nach der Einwilligung durch Ihre CMP geladen, und Sie müssen das Laden entsprechend bedingen. Die vollständige Liste der Tracker, der verarbeiteten Daten, der Zwecke und Rechtsgrundlagen, des Hostings, der Unterauftragsverarbeiter und der Sicherheit finden Sie unter Cookies, CMP & Datenschutz.