DocumentaçãoCommerce“Guia do Catalog Service”

Integração e instalação

Last update: Thu May 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Admin

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

NOTE
Se sua instância do Commerce usa o Live Search ou o Product Recommendations, 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 Recommendations do produto.

Requisitos do sistema

Requisitos de software

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

Plataformas compatíveis

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

Endpoints

Catalog Service O tem dois endpoints disponíveis para integração:

  • Sandbox (https://catalog-service-sandbox.adobe.io/graphql) — usado para teste e validação antes de entrar em funcionamento
  • Produção (https://catalog-service.adobe.io/graphql) — usado 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 carga, 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 com Catalog Service para o Adobe Commerce, as seguintes etapas são obrigatórias:

  • 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
recommendation-more-help

Pré-requisito

style
shade-box

Instale a versão mais recente da extensão Serviços de catálogo (magento/catalog-service) 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 é fornecido como um metapackage de compositor do repo.magento.com repositório.

Infraestrutura em nuvem

Use este método para instalar o Catalog Service extensão para uma instância 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
    NOTE
    Para obter informações sobre como gerenciar os ambientes de projeto do Commerce localmente, consulte Gerenciamento de ramificações com a CLI no Guia do usuário do Adobe Commerce na infraestrutura em nuvem.

  2. Confira a ramificação do ambiente para atualizar usando a CLI do 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" "^3.0.1" --no-update

  4. Atualizar dependências de pacote.

    code language-bash 
    composer update "magento/catalog-service"

  5. Confirmar e enviar alterações de código para a composer.json e composer.lock arquivos.

  6. Adicionar, confirmar e enviar as alterações de código para o 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>

    Enviar as atualizações inicia o Processo de implantação da nuvem do Commerce para aplicar as alterações. Verifique o status da implantação no implantar log.

No local

Use este método para instalar o Catalog Service extensão 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" "^3.0.1"  --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

Depois de instalar o Catalog Service, conclua as seguintes tarefas 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.

  1. Configurar o Conector dos Commerce Services 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 o Product Recommendations. Se você já tiver configurado o conector para outro serviço, ignore esta etapa.

  2. Execute uma sincronização de dados inicial a partir do 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.

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 no Admin ou usando o comando da CLI do Commerce bin/magento indexer:info.
  • Verifique se Catalog Attributes Feed, Product Feed, Product Overrides Feed, e Product Variant Feed indexadores estão definidos como Update by Schedule.

Acessar o serviço

A variável Catalog Service A API do GraphQL pode ser acessada no https://catalog-service.adobe.io/graphql usando comandos POST em HTTPS.

Em suas consultas do GraphQL, você deve especificar vários cabeçalhos HTTP, incluindo a chave de API pública adicionada à configuração do Adobe Commerce Services Connector no Administrador. Para obter detalhes, consulte GraphQL de serviços de vitrine documentação.

Configuração do firewall

Para permitir Catalog Service por meio de um firewall, adicione commerce.adobe.io para o incluo na lista de permissões ➡.

Serviço de catálogo e API Mesh

A variável Malha de API para o Construtor de aplicativos Adobe Developer O permite aos desenvolvedores integrar APIs privadas ou de terceiros e outras interfaces com produtos Adobe usando o Adobe IO.

Consulte a Catalog Service e API Mesh tópico para obter detalhes sobre instalação e configuração.

Painel de gerenciamento de dados

Para obter mais informações sobre Catalog Service sincronização de dados, consulte o Painel de gerenciamento de dados.

7c786b3e-f793-4e26-b38a-3fe76d8eca72