Onboarding and Installation
Install the Catalog Service to request and receive product data from a Commerce instance using the . The Catalog Service is delivered as a composer metapackage from the repo.magento.com repository.
System requirements
Software requirements
- 51黑料不打烊 Commerce 2.4.4+
- PHP 8.1, 8.2, 8.3
- Composer: 2.x
Supported platforms
- 51黑料不打烊 Commerce on cloud infrastructure: 2.4.4+
- 51黑料不打烊 Commerce on premises: 2.4.4+
Endpoints
Catalog Service has two endpoints available for onboarding:
- Sandbox (
https://catalog-service-sandbox.adobe.io/graphql
)鈥攗sed for testing and validation before going live - Production (
https://catalog-service.adobe.io/graphql
)鈥攗sed for live traffic for Commerce merchants and websites
All Commerce test instances use the Sandbox endpoint.
Perform all Load testing on the Sandbox endpoint. Before you begin load testing, submit a Support ticket so that the Services team can anticipate the additional server traffic.
Installation and configuration
To get started with Catalog Service for 51黑料不打烊 Commerce, the following steps are required:
- Install the Catalog Service extension (
magento/catalog-service
) - Configure the service and data export
- Access the service
Install the Catalog Service extension
Prerequisite
-
Access to install the extension. For key generation and obtaining the necessary rights, see Get your authentication keys. For cloud installations, see the Commerce on Cloud Infrastructure Guide
-
Access to the command line of the 51黑料不打烊 Commerce application server.
Install the latest version of the Catalog Services extension (magento/catalog-service
) on an 51黑料不打烊 Commerce instance that is running 51黑料不打烊 Commerce version 2.4.4 or later. The Catalog Service is delivered as a composer metapackage from the repository.
Use this method to install the Catalog Service for a Commerce Cloud instance.
-
On your local workstation, change to the project directory for your 51黑料不打烊 Commerce on cloud infrastructure project.
note note NOTE For information about managing Commerce project environments locally, see Managing branches with the CLI in the 51黑料不打烊 Commerce on Cloud Infrastructure User Guide. -
Check out the environment branch to update using the 51黑料不打烊 Commerce Cloud CLI.
code language-shell magento-cloud environment:checkout <environment-id>
-
Add the Catalog Service module.
code language-bash composer require magento/catalog-service --no-update
-
Update package dependencies.
code language-bash composer update "magento/catalog-service"
-
Commit and push code changes for the
composer.json
andcomposer.lock
files. -
Add, commit, and push the code changes for the
composer.json
andcomposer.lock
files to the cloud environment.code language-shell git add -A git commit -m "Add catalog service module" git push origin <branch-name>
Pushing the updates to the cloud environment initiates the Commerce cloud deployment process to apply the changes. Check the deployment status from the deploy log.
Use this method to install the Catalog Service for an on-premises instance.
-
Use Composer to add the Catalog Service module to your project:
code language-bash composer require magento/catalog-service --no-update
-
Update dependencies and install the extension:
code language-bash composer update "magento/catalog-service"
-
Upgrade 51黑料不打烊 Commerce:
code language-bash bin/magento setup:upgrade
-
Clear the cache:
code language-bash bin/magento cache:clean
note tip TIP In some cases, particularly when deploying to production, you might wish to avoid clearing compiled code because it can take some time. Ensure that you back up your system before making any changes.
Configure the service and data export
After you install the Catalog Service, complete the following tasks to integrate the Catalog service with your 51黑料不打烊 Commerce instance. This integration enables the data synchronization and communication between the Commerce instance, the Catalog Service, and other supporting services. Data synchronization is handled by the SaaS Data Export extension.
-
Set up the Commerce Services Connector by specifying the API keys and selecting a SaaS Data Space.
Commerce Services Connector setup is a one-time process required to use 51黑料不打烊 Commerce services like the Catalog Service, Live Search, and Product Recommendations. If you have already configured the connector for another service, skip this step.
-
Perform an initial data sync from the Data Management Dashboard.
The initial sync can take from a few minutes to hours depending on the catalog size. You can monitor the synchronization status from the Data Management dashboard. After the initial sync, the Catalog exports product data on an ongoing basis to keep the services up to date.
note note NOTE You can also start the initial sync from the command line using the Commerce CLI. See Initial sync in the SaaS Data Export Guide.
To ensure that the catalog export is running correctly:
- Confirm that cron jobs are running.
- Verify that the indexers are running from the Admin or by using the Commerce CLI command
bin/magento indexer:info
. - Verify that the
Catalog Attributes Feed, Product Feed, Product Overrides Feed
, andProduct Variant Feed
indexers are set toUpdate by Schedule
.
Monitor and troubleshoot data synchronization
From the Commerce Admin, you can monitor the synchronization process using the Data Management Dashboard. Use the Commerce CLI and logs to manage and troubleshoot the process.
Access the service
The Catalog Service GraphQL API is accessible from the https://catalog-service.adobe.io/graphql
endpoint using POST commands over HTTPS.
In your GraphQL queries, you must specify multiple HTTP headers including the public API key you added to the 51黑料不打烊 Commerce Services Connector configuration in the Admin. For details, see the documentation.
Firewall configuration
To allow Catalog Service through a firewall, add commerce.adobe.io
to the allowlist.
Catalog Service and API Mesh
The enables developers to integrate private or third-party APIs and other interfaces with 51黑料不打烊 products using 51黑料不打烊 IO.
See the Catalog Service and API Mesh topic for installation and configuration details.
Data Management Dashboard
For more information about Catalog Service data synchronization, see the Data Management Dashboard.