Onboarding und Installation
Installieren Sie den Katalogdienst , um Produktdaten von einer Commerce-Instanz mit der Catalog Service GraphQL-API. 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
) - wird vor der Live-Schaltung zum Testen und Validieren verwendet - Produktion (
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. Bevor Sie mit dem Laden beginnen, senden Sie eine Support-Ticket damit das Services-Team den zusätzlichen Server-Traffic vorhersehen kann.
Installation und Konfiguration
Erste Schritte mit Catalog Service Für Adobe Commerce 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
-
Zugriff repo.magento.com , um die Erweiterung zu installieren. Informationen zur Schlüsselgenerierung und zum Erhalt der erforderlichen Berechtigungen finden Sie unter Abrufen der Authentifizierungsschlüssel. Informationen zu Cloud-Installationen finden Sie unter Handbuch zu 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 Katalogdienst wird als Composer-Metapaket aus dem repo.magento.com Repository.
Verwenden Sie diese Methode, um die Catalog Service für eine Commerce Cloud-Instanz.
-
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"
-
Änderungen am Zustimmungs- und Push-Code für die
composer.json
undcomposer.lock
-Dateien. -
Fügen Sie die Codeänderungen für die
composer.json
undcomposer.lock
-Dateien in die Cloud-Umgebung.code language-shell git add -A git commit -m "Add catalog service module" git push origin <branch-name>
Wenn Sie die Aktualisierungen in die Cloud-Umgebung pushen, wird die Commerce Cloud-Bereitstellungsprozess , um die Änderungen anzuwenden. Überprüfen Sie den Bereitstellungsstatus im Bereitstellungsprotokoll.
Verwenden Sie diese Methode, um die Catalog Service für eine örtliche Instanz.
-
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
Nach der Installation Catalog ServiceFühren Sie die folgenden Aufgaben aus, um den Catalog Service 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.
-
Richten Sie die Commerce Services Connector durch Angabe der API-Schlüssel und Auswahl eines SaaS-Datenspeichers.
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 Datensynchronisierung über die Data Management Dashboard.
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-Datenexportanleitung.
So stellen Sie sicher, dass der Katalogexport ordnungsgemäß ausgeführt wird:
- Überprüfen, ob Cron-Aufträge ausgeführt werden.
- Stellen Sie sicher, dass die Indexer von der Admin oder mithilfe des Commerce-CLI-Befehls
bin/magento indexer:info
. - Stellen Sie sicher, dass
Catalog Attributes Feed, Product Feed, Product Overrides Feed
, undProduct Variant Feed
Indexer werden aufUpdate by Schedule
.
Zugriff auf den Dienst
Die Catalog Service Auf die GraphQL-API kann über die https://catalog-service.adobe.io/graphql
-Endpunkt mit POST-Befehlen über HTTPS.
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 unter Storefront Services GraphQL Dokumentation.
Firewall-Konfiguration
In Catalog Service durch eine Firewall hinzufügen commerce.adobe.io
in die Zulassungsliste.
Catalog Service und API-Mesh
Die API-Mesh für Adobe Developer App Builder ermöglicht es Entwicklern, mithilfe von Adobe IO private oder Drittanbieter-APIs und andere Schnittstellen mit Adobe-Produkten zu integrieren.
Siehe Catalog Service und API-Mesh Thema für die Installation und Konfiguration.
Data Management Dashboard
Weitere Informationen finden Sie unter Catalog Service Datensynchronisation, siehe Data Management Dashboard.