Onboarding und Installation
Installieren Sie den Katalog-Service, um Produktdaten von einer Commerce-Instanz mithilfe der Catalog Service GraphQL-API anzufordern und zu empfangen. Der Katalog-Service wird als Composer-Metapaket aus dem Repository repo.magento.com bereitgestellt.
Systemanforderungen
Softwareanforderungen
- Adobe Commerce 2.4.4+
- PHP 8.1, 8.2, 8.3
- Komponist: 2.x
Unterstützte Plattformen
- Adobe Commerce auf Cloud-Infrastruktur: 2.4.4+
- Adobe Commerce On-Premises: 2.4.4+
Endpunkte
Catalog Service stehen zwei Endpunkte für das Onboarding zur Verfügung:
- Sandbox (
https://catalog-service-sandbox.adobe.io/graphql
) - wird vor der Live-Schaltung zu Test- und Validierungszwecken verwendet - Production (
https://catalog-service.adobe.io/graphql
) - wird 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. Senden Sie vor Beginn des Auslastungstests ein Support-Ticket, damit das Services-Team den zusätzlichen Server-Traffic antizipieren kann.
Installation und Konfiguration
Um mit Catalog Service für Adobe Commerce zu beginnen, sind die folgenden Schritte erforderlich:
- Installieren der Catalog Service-Erweiterung (
magento/catalog-service
) - Konfigurieren des Service und des Datenexports
- Zugriff auf den Service
Installieren der Catalog Service-Erweiterung
Voraussetzung
-
Greifen Sie auf repo.magento.com zu, um die Erweiterung zu installieren. Informationen zum Generieren von Schlüsseln und zum Abrufen der erforderlichen Berechtigungen finden Sie unter Abrufen Ihrer Authentifizierungsschlüssel. Informationen zu Cloud-Installationen finden Sie im Handbuch Commerce on Cloud Infrastructure
-
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 Katalog-Service wird als Composer-Metapaket aus dem 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 in das Projektverzeichnis für Ihr Adobe Commerce on Cloud-Infrastrukturprojekt.
note note NOTE Informationen zur lokalen Verwaltung von Commerce-Projektumgebungen finden Sie unter Verwalten von Verzweigungen mit der CLI im Benutzerhandbuch für Adobe Commerce auf Cloud-Infrastruktur. -
Checken Sie die Umgebungsverzweigung aus, um sie mithilfe der Adobe Commerce Cloud-CLI zu aktualisieren.
code language-shell magento-cloud environment:checkout <environment-id>
-
Fügen Sie das Modul Katalog-Service hinzu.
code language-bash composer require magento/catalog-service --no-update
-
Paketabhängigkeiten aktualisieren.
code language-bash composer update "magento/catalog-service"
-
Code-Änderungen für
composer.json
undcomposer.lock
übertragen und übertragen. -
Fügen Sie die Code-Änderungen für die
composer.json
- undcomposer.lock
-Dateien 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 Pushen der Aktualisierungen in die Cloud-Umgebung wird der Commerce-Cloud-Bereitstellungsprozess gestartet, 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 das Modul Katalog-Service zu Ihrem Projekt 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"
-
Adobe Commerce aktualisieren:
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 Produktion, empfiehlt es sich möglicherweise, kompilierten Code nicht zu löschen, da dies einige Zeit in Anspruch nehmen kann. Stellen Sie sicher, dass Sie Ihr System sichern, bevor Sie Änderungen vornehmen.
Konfigurieren des Service und des Datenexports
Führen Sie nach der Installation des Catalog Service die folgenden Schritte aus, um den Katalog-Service in Ihre Adobe Commerce-Instanz zu integrieren. Diese Integration ermöglicht die Datensynchronisation und Kommunikation zwischen der Commerce-Instanz, dem Katalog-Service und anderen unterstützenden Services. Die Datensynchronisation wird von der SaaS-Datenexporterweiterung“.
-
Richten Sie den Commerce Services-Connector ein indem Sie die API-Schlüssel angeben und einen SaaS-Datenspeicher auswählen.
Die Einrichtung des Commerce Services-Connectors ist ein einmaliger Prozess, der zur Verwendung von Adobe Commerce-Services wie dem Katalog-Service, der Live-Suche und den Produktempfehlungen 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 Data Management Dashboard durch.
Die erste Synchronisierung kann je nach Kataloggröße einige Minuten bis Stunden dauern. Sie können den Synchronisierungsstatus über das Daten-Management-Dashboard überwachen. Nach der ersten Synchronisierung exportiert der Katalog laufend Produktdaten, um die Services auf dem neuesten Stand zu halten.
note note NOTE Sie können die Erstsynchronisierung auch über die Befehlszeile starten, indem Sie die Commerce-CLI verwenden. Siehe Erstsynchronisierung im SaaS-Datenexporthandbuch.
So stellen Sie sicher, dass der Katalogexport ordnungsgemäß ausgeführt wird:
- Bestätigen Sie, dass Cron-Aufträge ausgeführt werden.
- Stellen Sie sicher, dass die Indexer vom Admin oder mithilfe des Commerce CLI-
bin/magento indexer:info
ausgeführt werden. - Stellen Sie sicher, dass die
Catalog Attributes Feed, Product Feed, Product Overrides Feed
- undProduct Variant Feed
-Indexer aufUpdate by Schedule
eingestellt sind.
Überwachen und Fehlerbehebung bei der Datensynchronisation
Vom Commerce-Administrator aus können Sie den Synchronisierungsprozess mithilfe des Daten-Management-Dashboards“. Verwenden Sie die Commerce-CLI und Protokolle, um den Prozess zu verwalten und Fehler zu beheben.
Zugriff auf den Service
Auf die Catalog Service GraphQL-API kann über den https://catalog-service.adobe.io/graphql
-Endpunkt mithilfe von POST-Befehlen über HTTPS zugegriffen werden.
In Ihren GraphQL-Abfragen müssen Sie mehrere HTTP-Kopfzeilen angeben, einschließlich des öffentlichen API-Schlüssels, den Sie der Adobe Commerce Services Connector-Konfiguration in Admin hinzugefügt haben. Weitere Informationen finden Sie in der Storefront Services GraphQL-Dokumentation.
Firewall-Konfiguration
Um Catalog Service durch eine Firewall zuzulassen, fügen Sie commerce.adobe.io
zur Zulassungsliste hinzu.
Katalog-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 Benutzeroberflächen mit Adobe-Produkten mithilfe von Adobe IO.
Informationen zur Installation Catalog Service Konfiguration finden SieThema „und API-Mesh“ .
Dashboard für das Daten-Management
Weitere Informationen zur Catalog Service Datensynchronisation finden Sie unter Data Management Dashboard.