[Somente PaaS]{class="badge informative" title="Aplica-se somente a projetos do Adobe Commerce na nuvem (infraestrutura do PaaS gerenciada pela Adobe) e a projetos locais."}

Integração e instalação

NOTE
Para soluções da Commerce que usam o Adobe Commerce Optimizer ou o Adobe Commerce Optimizer Connector, use a API do GraphQL de Serviços de Merchandising em vez da API do GraphQL de Serviços de Catálogo.

Instale o Serviço de Catálogo para solicitar e receber dados do produto de uma instância do Commerce usando a API GraphQL do Serviço de Catálogo. O Serviço de catálogo é fornecido como um metapackage de PHP compositor a partir do repositório repo.magento.com.

NOTE
Se sua instância do Commerce usa o Live Search ou as Recomendações de produto, o Serviço de catálogo será instalado ou atualizado automaticamente quando você integrar ou atualizar esses serviços. Para obter detalhes, consulte as instruções de instalação do Live Search e do Product Recommendations.
Se você estiver usando o Adobe Commerce as a Cloud Service, a versão mais recente do metapackage estará disponível em seu ambiente. Para começar a usar os serviços, consulte Introdução ao Serviço de Catálogo.
Para implementações de vitrine da Commerce usando o Adobe Commerce Optimizer, consulte o Guia do Desenvolvedor de Serviços de Merchandising.

Requisitos do sistema

Requisitos de software

  • Adobe Commerce 2.4.4+
  • PHP 8.1, 8.2, 8.3, 8.4
  • Compositor: 2.x

Plataformas com suporte

  • Adobe Commerce na infraestrutura em nuvem: 2.4.4+
  • Adobe Commerce no local: 2.4.4+

Endpoints

Catalog Service tem dois pontos de extremidade disponíveis para integração:

  • Sandbox (https://catalog-service-sandbox.adobe.io/graphql) — usada para teste e validação antes de entrar em funcionamento
  • Produção (https://catalog-service.adobe.io/graphql) — usada para tráfego direto para comerciantes e sites da Commerce

Todas as instâncias de teste do Commerce usam o ponto de extremidade da sandbox.

Execute todos os testes de carga no endpoint da sandbox. Antes de começar o teste de carregamento, envie um Tíquete de suporte para que a equipe de Serviços possa antecipar o tráfego adicional do servidor.

Instalação e configuração

Para começar a usar o Catalog Service for Adobe Commerce, siga estas etapas:

  • Instalar a extensão Serviço de Catálogo (magento/catalog-service)
  • Configurar o serviço e a exportação de dados
  • Acessar o serviço

Pré-requisito

Instale a versão mais recente da extensão (magento/catalog-service) do Catalog Services em uma instância do Adobe Commerce que esteja executando o Adobe Commerce versão 2.4.4 ou posterior. O Serviço de Catálogo é entregue como um metapackage de compositor do repositório repo.magento.com.

Infraestrutura em nuvem

Use este método para instalar o Catalog Service para uma instância do Commerce Cloud.

  1. Na estação de trabalho local, altere para o diretório do projeto do Adobe Commerce na infraestrutura em nuvem.

    note
    NOTE
    Para obter informações sobre o gerenciamento local de ambientes de projeto do Commerce, consulte Gerenciamento de ramificações com a CLI no Guia do Usuário do Adobe Commerce na Infraestrutura da Nuvem.
  2. Confira a ramificação de ambiente para atualizar usando a CLI da Adobe Commerce Cloud.

    code language-shell
    magento-cloud environment:checkout <environment-id>
    
  3. Adicione o módulo Serviço de Catálogo.

    code language-bash
    composer require magento/catalog-service --no-update
    
  4. Atualizar dependências de pacote.

    code language-bash
    composer update "magento/catalog-service"
    
  5. Adicione, confirme e envie por push as alterações de código dos arquivos composer.json e composer.lock para o ambiente de nuvem.

    code language-shell
    git add -A
    git commit -m "Add catalog service module"
    git push origin <branch-name>
    

    A ação de enviar as atualizações para o ambiente de nuvem inicia o processo de implantação da nuvem do Commerce para aplicar as alterações. Verifique o status da implantação no log de implantação.

No local

Use este método para instalar o Catalog Service para uma instância local.

  1. Use o Composer para adicionar o módulo Serviço de catálogo ao seu projeto:

    code language-bash
    composer require magento/catalog-service --no-update
    
  2. Atualize as dependências e instale a extensão:

    code language-bash
    composer update  "magento/catalog-service"
    
  3. Atualizar o Adobe Commerce:

    code language-bash
    bin/magento setup:upgrade
    
  4. Limpe o cache:

    code language-bash
    bin/magento cache:clean
    
    note tip
    TIP
    Em alguns casos, especialmente ao implantar na produção, você pode evitar a limpeza do código compilado, pois pode levar algum tempo. Certifique-se de fazer backup do sistema antes de fazer qualquer alteração.

Configurar o serviço e a exportação de dados

Após instalar o Catalog Service, conclua as tarefas a seguir para integrar o serviço de Catálogo à sua instância do Adobe Commerce. Essa integração permite a sincronização de dados e a comunicação entre a instância do Commerce, o Serviço de catálogo e outros serviços de suporte. A sincronização de dados é realizada pela extensão de Exportação de Dados SaaS.

  1. Configure o Commerce Services Connector especificando as chaves de API e selecionando um Espaço de Dados SaaS.

    A configuração do Commerce Services Connector é um processo único necessário para usar serviços da Adobe Commerce, como o Serviço de catálogo, o Live Search e as Recomendações de produto. Se você já tiver configurado o conector para outro serviço, ignore esta etapa.

  2. Execute uma sincronização de dados inicial no Painel de Gerenciamento de Dados.

    A sincronização inicial pode levar de alguns minutos a horas, dependendo do tamanho do catálogo. Você pode monitorar o status de sincronização no painel de Gerenciamento de dados. Após a sincronização inicial, o Catálogo exporta dados do produto de forma contínua para manter os serviços atualizados.

    note
    NOTE
    Você também pode iniciar a sincronização inicial a partir da linha de comando usando a Commerce CLI. Consulte Sincronização inicial no Guia de exportação de dados SaaS.

Para garantir que a exportação de catálogo esteja sendo executada corretamente:

  • Confirme se os trabalhos cron estão em execução.
  • Verifique se os indexadores estão sendo executados do Admin ou usando o comando bin/magento indexer:info da CLI do Commerce.
  • Verifique se os indexadores Catalog Attributes Feed, Product Feed, Product Overrides Feed e Product Variant Feed estão definidos como Update by Schedule.

Monitorar e solucionar problemas de sincronização de dados

Para verificar se a sincronização de dados está funcionando, confirme se os dados foram exportados com êxito do Adobe Commerce e se foram entregues com êxito ao serviço Commerce conectado. Use os painéis da sua implantação para verificar ambas as etapas.

Comece com export e depois confirme o delivery.

  1. Verifique o status de sincronização no Commerce Admin.

    Vá para System > Data Transfer > Data Feed Sync Status.

    Página Status da sincronização do feed de dados com relatórios de status do item de feed {width="800" modal="regular"}

    Quando a sincronização está em execução, os dados do feed mostram registros enviados com êxito. Selecione um feed para ver detalhes ou solucionar problemas de sincronização.

  2. Confirme se os dados foram entregues aos Serviços Commerce conectados.

    No Administrador do Commerce, vá para System > Data Transfer > Data Management Dashboard.

    Painel de Gerenciamento de Dados mostrando dados de catálogo sincronizados nos Serviços Commerce conectados {width="700" modal="regular"}

    Verifique se os produtos, preços e atributos esperados aparecem.

TIP
Se você tiver problemas adicionais com a sincronização de dados, consulte Revisar logs e solucionar problemas.

Use a CLI do Commerce para ressincronizar manualmente os feeds quando necessário. Para opções de ressincronização e etapas adicionais de solução de problemas, consulte Gerenciar sincronização no Guia de Exportação de Dados SaaS.

NOTE
Se a página Status da sincronização do feed de dados não estiver disponível no Commerce Admin for Commerce em implantações na nuvem ou locais, siga as instruções de instalação da extensão para habilitá-la.
recommendation-more-help
commerce-help-catalog-service