Onboarding und Installation
Installieren Sie den Catalog Service , um mithilfe der Catalog Service GraphQL API Produktdaten von einer Commerce-Instanz anzufordern und zu empfangen. Der Catalog Service wird als Composer-Metapaket vom repo.magento.com Repository bereitgestellt.
Systemanforderungen
Softwareanforderungen
- Adobe Commerce 2.4.4+
- PHP 8.1, 8.2, 8.3
- Verfasser: 2.x
Unterstützte Plattformen
- Adobe Commerce für Cloud-Infrastruktur: 2.4.4+
- Adobe Commerce vor Ort: 2.4.4+
Endpunkte
Catalog Service verfügt über zwei Endpunkte, die für das Onboarding verfügbar sind:
- Sandbox (
https://catalog-service-sandbox.adobe.io/graphql
), die vor der Live-Schaltung zum Testen und Validieren verwendet wird - Produktion (
https://catalog-service.adobe.io/graphql
) - für Live-Traffic für Commerce-Händler und -Websites verwendet
Alle Commerce-Testinstanzen verwenden den Sandbox-Endpunkt.
Führen Sie alle Belastungstests für den Sandbox-Endpunkt durch. Bevor Sie mit dem Laden beginnen, senden Sie ein Support-Ticket, damit das Services-Team den zusätzlichen Server-Traffic vorhersehen kann.
Installation und Konfiguration
Um mit Catalog Service für Adobe Commerce zu beginnen, sind die folgenden Schritte erforderlich:
- Installieren Sie die Catalog Service-Erweiterung (
magento/catalog-service
) - Dienst und Datenexport konfigurieren
- Zugriff auf den Dienst
Installieren der Catalog Service-Erweiterung
Voraussetzung
-
Rufen Sie repo.magento.com auf, um die Erweiterung zu installieren. Informationen zur Schlüsselgenerierung und zum Abrufen der erforderlichen Berechtigungen finden Sie unter Abrufen Ihrer Authentifizierungsschlüssel. Informationen zu Cloud-Installationen finden Sie im Commerce on Cloud Infrastructure Guide
-
Zugriff auf die Befehlszeile des Adobe Commerce-Anwendungsservers.
Installieren Sie die neueste Version der Catalog Services-Erweiterung (magento/catalog-service
) auf einer Adobe Commerce-Instanz, auf der Adobe Commerce-Version 2.4.4 oder höher ausgeführt wird. Der Catalog Service wird als Composer-Metapaket vom Repository repo.magento.com bereitgestellt.
Verwenden Sie diese Methode, um die Catalog Service für eine Commerce Cloud-Instanz zu installieren.
-
Wechseln Sie auf Ihrer lokalen Workstation zum Projektverzeichnis für Ihr Adobe Commerce-Projekt in der Cloud-Infrastruktur-Projekt.
note note NOTE Informationen zum lokalen Verwalten von Commerce-Projektumgebungen finden Sie unter Verwalten von Verzweigungen mit der CLI im Benutzerhandbuch zu Adobe Commerce on Cloud Infrastructure. -
Sehen Sie sich die Umgebungsverzweigung an, die mit der Adobe Commerce Cloud-CLI aktualisiert werden soll.
code language-shell magento-cloud environment:checkout <environment-id>
-
Fügen Sie das Modul Catalog Service hinzu.
code language-bash composer require magento/catalog-service --no-update
-
Aktualisieren Sie Package-Abhängigkeiten.
code language-bash composer update "magento/catalog-service"
-
Übernehmen und pushen Sie Code-Änderungen für die Dateien
composer.json
undcomposer.lock
. -
Fügen Sie die Codeänderungen für die Dateien
composer.json
undcomposer.lock
hinzu, übertragen Sie sie und übertragen Sie sie in die Cloud-Umgebung.code language-shell git add -A git commit -m "Add catalog service module" git push origin <branch-name>
Durch das Übermitteln der Aktualisierungen an die Cloud-Umgebung wird der Commerce-Cloud-Bereitstellungsprozess initiiert, um die Änderungen anzuwenden. Überprüfen Sie den Bereitstellungsstatus im Bereitstellungsprotokoll.
Verwenden Sie diese Methode, um die Catalog Service für eine lokale Instanz zu installieren.
-
Verwenden Sie Composer, um Ihrem Projekt das Catalog Service-Modul hinzuzufügen:
code language-bash composer require magento/catalog-service --no-update
-
Aktualisieren Sie die Abhängigkeiten und installieren Sie die Erweiterung:
code language-bash composer update "magento/catalog-service"
-
Upgrade von Adobe Commerce:
code language-bash bin/magento setup:upgrade
-
Löschen Sie den Cache:
code language-bash bin/magento cache:clean
note tip TIP In einigen Fällen, insbesondere bei der Bereitstellung in der Produktionsumgebung, sollten Sie das Löschen von kompiliertem Code vermeiden, da dies einige Zeit in Anspruch nehmen kann. Stellen Sie sicher, dass Sie Ihr System sichern, bevor Sie Änderungen vornehmen.
Dienst und Datenexport konfigurieren
Führen Sie nach der Installation von Catalog Service die folgenden Schritte aus, um den Catalog-Dienst in Ihre Adobe Commerce-Instanz zu integrieren. Diese Integration ermöglicht die Datensynchronisation und Kommunikation zwischen der Commerce-Instanz, dem Catalog Service und anderen unterstützenden Diensten. Die Datensynchronisation wird von der SAAS-Datenexport-Erweiterung durchgeführt.
-
Richten Sie den Commerce Services Connector ein, indem Sie die API-Schlüssel angeben und einen SaaS-Datenraum auswählen.
Die Einrichtung des Commerce Services Connector ist ein einmaliger Prozess, der für die Verwendung von Adobe Commerce-Diensten wie dem Katalogdienst, der Live-Suche und der Produkt-Recommendations erforderlich ist. Wenn Sie den Connector bereits für einen anderen Dienst konfiguriert haben, überspringen Sie diesen Schritt.
-
Führen Sie eine erste Datensynchronisation über das Daten-Management-Dashboard durch.
Die anfängliche Synchronisation kann abhängig von der Kataloggröße einige Minuten bis Stunden dauern. Sie können den Synchronisierungsstatus im Data Management-Dashboard überwachen. Nach der ersten Synchronisierung exportiert der Katalog laufend Produktdaten, um die Dienste auf dem neuesten Stand zu halten.
note note NOTE Sie können die Erstsynchronisierung auch über die Befehlszeile mit der Commerce-CLI starten. Siehe Erstsynchronisierung im SAAS-Datenexportleitfaden.
So stellen Sie sicher, dass der Katalogexport ordnungsgemäß ausgeführt wird:
- Vergewissern Sie sich, dass Cron-Aufträge ausgeführt werden.
- Stellen Sie sicher, dass die Indexer über den Befehl Admin oder den Commerce-CLI-Befehl
bin/magento indexer:info
ausgeführt werden. - Stellen Sie sicher, dass die Indexer
Catalog Attributes Feed, Product Feed, Product Overrides Feed
undProduct Variant Feed
aufUpdate by Schedule
eingestellt sind.
Überwachung und Fehlerbehebung bei der Datensynchronisation
Über den Commerce-Administrator können Sie den Synchronisierungsprozess mithilfe des Daten-Management-Dashboards überwachen. Verwenden Sie die Commerce-CLI und Protokolle, um den Prozess zu verwalten und Fehler zu beheben.
Zugriff auf den Dienst
Der Zugriff auf die GraphQL-API Catalog Service erfolgt über die POST-Befehle über HTTPS vom https://catalog-service.adobe.io/graphql
-Endpunkt aus.
In Ihren GraphQL-Abfragen müssen Sie mehrere HTTP-Header angeben, einschließlich des öffentlichen API-Schlüssels, den Sie in der Admin-Konfiguration von Adobe Commerce Services Connector hinzugefügt haben. Weitere Informationen finden Sie in der Dokumentation zu Storefront Services GraphQL .
Firewall-Konfiguration
Um Catalog Service über eine Firewall zuzulassen, fügen Sie commerce.adobe.io
zur Zulassungsliste hinzu.
Catalog Service und API-Mesh
Das API-Mesh für Adobe Developer App Builder ermöglicht Entwicklern die Integration von privaten oder Drittanbieter-APIs und anderen Schnittstellen mit Adobe-Produkten mithilfe von Adobe IO.
Informationen zur Installation und Konfiguration finden Sie im Thema Catalog Service und zum API-Mesh .
Data Management Dashboard
Weitere Informationen zur Catalog Service Datensynchronisation finden Sie im Dashboard "Datenverwaltung".