Onboarding and Installation

Last update: 2024-02-22
  • Created for:
  • Admin

The following videos walk you through the Catalog Service process.

Part 1: Onboarding and installation

Part 2: Using the Catalog Service

Prerequisites

The onboarding process for Catalog Service requires access to the command line of the server. If you are not familiar with working from the command line, ask a developer or system integrator to help.

Software requirements

  • Adobe Commerce 2.4.4+
  • PHP 8.1, 8.2
  • Composer: 2.x

Supported platforms

  • Adobe Commerce on cloud infrastructure: 2.4.4+
  • Adobe Commerce on premises: 2.4.4+

Endpoints

Catalog Service has two endpoints available for onboarding:

  • Sandbox (https://catalog-service-sandbox.adobe.io/graphql)—used for testing and validation before going live
  • Production (https://catalog-service.adobe.io/graphql)—used for live traffic for Commerce merchants and websites

All test instances of Commerce should use the Sandbox endpoint.

Load testing should only be performed on the Sandbox endpoint. It is recommended that a Support ticket be opened when load testing so the Services team can anticipate the additional server traffic.

Installation and configuration

To get started with Catalog Service for Adobe Commerce, the following steps are required:

  • Install the data export extensions
  • Configure the service and data export
  • Access the service

Install the data export extensions

The onboarding process for Catalog Service requires access to the command line of the server.

The Catalog Service extension can be installed on both Adobe Commerce cloud infrastructure and on-premises instances.

The Catalog Service is installed with Composer keys, which are linked to the Commerce account mageid provided during the signup process. Composer uses these keys during the initial installation of Adobe Commerce, or in situations in which the Composer keys were not previously saved to an external auth.json file.

See Get your authentication keys for more information about obtaining Composer keys.

Adobe Commerce on cloud infrastructure

Use this method for installing the Catalog Service extension for a Commerce Cloud instance.

  1. On your local workstation, change to your project directory.

  2. Add the Catalog Service module.

    composer require "magento/catalog-service" "^3.0.1"
    
  3. Update package dependencies.

    composer update
    
  4. Commit and push code changes for the composer.json and composer.lock files.

On-premises

Use this method for installing the Catalog Service extension for an on-premises instance.

  1. Use Composer to add the Catalog Service module to your project:

    composer require "magento/catalog-service" "^3.0.1"
    
  2. Update dependencies and install the extension:

    composer update
    
  3. Upgrade Adobe Commerce:

    bin/magento setup:upgrade
    
  4. Clear the cache:

    bin/magento cache:clean
    

Configure the service and data export

After you install Catalog Service, you must configure the Commerce Services Connector by specifying the API keys and selecting a SaaS Data Space.

After the SaaS configuration is complete, perform an initial data sync by following the Catalog Sync guide.

To ensure that the catalog export is running correctly:

  • Confirm that cron jobs are running.
  • Verify that the indexers are running.
  • Ensure that the Catalog Attributes Feed, Product Feed, Product Overrides Feed, and Product Variant Feed indexers are set to “Update by Schedule”.

The initial sync could take from a few minutes to hours depending on the catalog size. After the initial sync, the Catalog exports product data from the Commerce server to Commerce services on an ongoing basis to keep the services up to date. To monitor the status of the sync, refer to the Data Management Dashboard.

Access the service

The Catalog Service API is accessible using POST commands over HTTPS.

To obtain the api-key, go to the Commerce Service Connector area in the admin and copy the public API key.

Read the GraphQL documentation to understand how to query and send the headers that are needed for generating API requests.

To allow Catalog Service through a firewall, add commerce.adobe.io to the allowlist.

Catalog Service and API Mesh

The API Mesh for Adobe Developer App Builder enables developers to integrate private or third-party APIs and other interfaces with Adobe products using Adobe IO.

See the Catalog Service and API Mesh topic for installation and configuration details.

Data Management Dashboard

Users can refer to the Data Management Dashboard for more data about Catalog Service data syncing.

On this page