Eventos de catálogo e guia de integração do Adobe I/O Events
Eventos de catálogo são notificações geradas por computador que descrevem alterações de catálogo com suporte disponibilizadas por meio do Catalog Service. Eles permitem fluxos de trabalho orientados por eventos, como:
- Manter caches ou serviços externos em sincronia com atualizações de catálogo.
- Acionando processos downstream quando produtos, variantes, preços ou categorias são alterados.
- Potencializando casos de uso do Experience Edge e do Edge Delivery Services que exigem atualizações de catálogo quase em tempo real.
Para obter o caminho de ponta a ponta de Adobe Commerce para os consumidores do evento, consulte Entrega de evento até Adobe I/O Events.
Tipos de evento suportados supported-event-types
Os eventos do catálogo se concentram em alterações relevantes para a loja expostas por meio de Adobe Developer Console. As seguintes assinaturas são suportadas no momento.
Cada evento inclui:
- Um identificador de evento que descreve o tipo de alteração.
- Contexto de entidade e ambiente, como ID de instância e SKU.
- Uma carga que descreve a entidade alterada e as informações relevantes do escopo.
Exemplo de cargas de evento
Evento ProductUpdated
{
"imsOrgId": "aaa-0",
"instanceId": "instance-9",
"eventCode": "productUpdated",
"sku": "1234",
"links": [
{"type": "variantOf", "sku": "5678"}
],
"scope": [
{ "storeViewCode": "US-us" },
{ "storeViewCode": "FR-fr" },
{ "storeViewCode": "DE-de" }
]
}
Evento PriceUpdated
{
"imsOrgId": "aaa-0",
"instanceId": "instance-9",
"eventCode": "priceUpdated",
"sku": "1234",
"scope": [
{
"websiteCode": "website1",
"customerGroupCode": "customer-group-code1"
},
{
"websiteCode": "website2",
"customerGroupCode": "customer-group-code2"
}
]
}
Entrega de evento até Adobe I/O Events event-delivery-through-adobe-io-events
O Adobe I/O Events entrega eventos de catálogo para suas integrações. O diagrama a seguir mostra o fluxo de alto nível das alterações no catálogo de Adobe Commerce até Catalog Service e Adobe I/O Events para os consumidores inscritos:
As etapas a seguir explicam cada entrega com mais detalhes:
- Adobe Commerce → Serviço de catálogo
Adobe Commerce exporta dados do catálogo para Catalog Service usando as extensões de exportação de dados SaaS suportadas.
-
Processamento do serviço de catálogo
- Catalog Service processa alterações de catálogo com suporte e as prepara para a entrega de eventos.
-
Serviço de Catálogo → Adobe I/O Events
- Eventos de catálogo publicados em Adobe I/O Events.
- Os consumidores assinam usando o registro em log, webhooks, Adobe I/O Runtime, Amazon EventBridge ou outros mecanismos de entrega com suporte.
Adobe I/O Events fornece:
- Pelo menos uma entrega por assinante (eventos duplicados são possíveis).
- Nenhuma garantia de pedido entre deliveries.
Seus consumidores devem lidar com eventos duplicados e delivery fora de ordem. Consulte Idempotência para obter orientação de implementação.
Casos de uso use-cases
Você pode usar Eventos de catálogo em vários cenários.
Entrega estática de site e borda
- Gerar novamente ou invalidar páginas de catálogo e fragmentos de vitrine quando os dados de catálogo forem alterados.
- Evite a sondagem frequente de Catalog Service APIs.
Indexação e armazenamento em cache de pesquisa
- Acione atualizações incrementais nos índices de pesquisa downstream.
- Atualizar camadas de cache ou exibições externas do catálogo quando os dados do produto ou da categoria forem alterados.
Integração com sistemas externos
- Encaminhar alterações de catálogo para sistemas externos, como PIM, mecanismos de precificação ou outros sistemas de linha de negócios.
- Mantenha os aplicativos downstream sincronizados sem acesso direto ao banco de dados.
Monitorização e observabilidade
Combinar eventos do Catálogo com monitoramento existente (por exemplo, Grafana e Prometheus) para:
- Monitorar a taxa de transferência de eventos.
- Detectar anomalias no volume de atualização do catálogo.
Ativar eventos de catálogo enable-catalog-events
Para ativar eventos de catálogo de ponta a ponta, siga estas etapas.
- Um ambiente Adobe Commerce com suporte habilitado para Catalog Service.
- A conexão Adobe I/O está configurada para o Adobe Commerce.
- Acesso a Adobe Developer Console na mesma organização IMS em que o ambiente do Commerce é provisionado.
- Para verificar a sincronização com os serviços SaaS do Commerce, use o Data Management Dashboard no Administrador.
- Recomendações de Produto v6.0, Live Search v4.1.0+ ou Catalog Service v1.17+ são necessárias para verificação do painel. A Adobe recomenda atualizar seu projeto do Commerce para as versões mais recentes compatíveis desses serviços. Para versões anteriores do serviço, use a Sincronização de Catálogo para verificação de sincronização.
Verificar dados do catálogo verify-catalog-data
Verifique se Catalog Service tem dados de catálogo atuais da instância Commerce antes de configurar. Os eventos do catálogo dependem da conclusão de SaaS Data Export em dois estágios - confirme ambos:
-
Confirme a exportação do feed do Commerce com êxito.
No Administrador Adobe Commerce, abra a página Status de sincronização do feed de dados (System > Data Transfer > Data Feed Sync Status) e confirme se o último status de exportação é bem-sucedido para cada feed do Catalog Service.
-
Confirme a sincronização bem-sucedida com os serviços Commerce conectados do Administrador Adobe Commerce.
No Administrador Adobe Commerce, abra o Painel de Gerenciamento de Dados (System > Data Transfer > Data Management Dashboard) e verifique se os dados dos produtos sincronizados incluem os produtos esperados.
Registrar e assinar Adobe I/O Events register-events
Defina em quais eventos do Commerce inscrever-se e registre-os no projeto.
Se sua instância não estiver na lista de seleção, ela não estará conectada a Adobe I/O. Para obter instruções sobre como corrigir o problema, consulte Configurar a Adobe I/O conexão na documentação do Adobe Commerce Developer.
-
Do Adobe Developer Console, faça logon na mesma organização IMS usada para o projeto do Commerce.
-
Crie um projeto para Eventos do catálogo Commerce ou adicione a API de eventos a um projeto existente.
-
Selecione APIs and services na navegação superior.
-
Na página Browse APIs and services, selecione a guia Events.
-
Encontre rapidamente APIs de eventos do catálogo da Commerce. Digite Catálogo na caixa de pesquisa ou filtre pelo produto Commerce.
-
No cartão Commerce Catalog Events, selecione Project.
-
-
Configure o registro de eventos.
Selecione a instância do Commerce da qual receberá notificações de eventos. Em seguida, selecione Next.
-
Escolha os eventos nos quais se inscrever.
Selecione as assinaturas de evento com suporte que você deseja receber, como Product Update ou Price Update. Em seguida, selecione Next.
-
Adicionar credenciais OAuth de servidor para servidor.
Insira um Credential name. Em seguida, selecione Next.
-
Insira um Event registration name e um Event registration description. Em seguida, selecione Next.
-
Na tela de registro final, aceite o consumidor padrão, a API de registro.
O consumidor padrão da API de registro no diário permite testar o registro de eventos e confirmar se os eventos foram entregues. Se você já configurou um webhook ou um consumidor de ação Adobe I/O Runtime, selecione-o aqui. Caso contrário, edite o registro do evento posteriormente quando o consumidor estiver pronto.
-
Selecione Complete registration.
Configurar consumidor de eventos configure-consumer
-
Configure um consumidor, como:
- Um ponto de acesso de webhook
- Uma ação Adobe I/O Runtime
- Outro destino compatível
-
Se você não selecionou um consumidor durante o registro, edite o registro do evento para adicionar os detalhes do consumidor.
-
No Adobe Developer Console, edite seu projeto. Em seguida, selecione o registro de evento que você criou.
-
Na página de detalhes do registro do evento, selecione Edit Events Registration.
-
Selecione Next até chegar à tela de seleção do consumidor. Em seguida, selecione o consumidor que você configurou.
-
Atualize o consumidor para o destino configurado. Em seguida, selecione Save configured events.
-
Validar o fluxo de eventos validate-event-flow
Eventos de catálogo são ativados para seu ambiente. Quando os dados do catálogo são alterados no Commerce, as atualizações fluem pelo Catalog Service para Adobe I/O Events, e o consumidor que você se inscreveu recebe o evento de catálogo correspondente. Revise Limites e práticas recomendadas antes de criar integrações de produção.
-
Faça uma alteração simples no catálogo com suporte, como atualizar um nome de produto ou alterar um preço.
-
Confirme os seguintes resultados:
- A alteração está visível por meio de Catalog Service APIs.
- O consumidor Adobe I/O Events recebe o produto ou evento de preço correspondente.
Limites e práticas recomendadas limits-and-best-practices
Ao criar eventos no catálogo, siga estas práticas recomendadas.
Idempotência idempotency
O Adobe I/O Events pode entregar o mesmo evento de catálogo mais de uma vez, e os eventos de um único produto podem chegar fora de ordem. Desenhar os consumidores para serem idempotentes ao:
- Uso de IDs de entidade com um campo de versão ou carimbo de data e hora.
- Ignorando com segurança notificações duplicadas para a mesma alteração.
Taxa de transferência e contrapressão
Catálogos grandes com altas taxas de atualização podem gerar um volume de eventos significativo. Verifique se:
- Os consumidores podem processar eventos no rendimento máximo.
- Use buffering, agrupamento ou filas, quando necessário.
Segurança e isolamento
- Adobe I/O Events impõe isolamento do locatário.
- Sua organização recebe eventos somente para seus próprios ambientes e direitos.
Evolução do esquema
As cargas de evento de catálogo seguem o mesmo modelo conceitual que Catalog Service APIs. Para permanecer compatível com o encaminhamento:
- Evite a aplicação rigorosa de esquemas sempre que possível.
- Ignorar campos desconhecidos em vez de falhar.
Solução de problemas de eventos de catálogo troubleshoot-catalog-events
Se os eventos de catálogo estiverem ausentes ou atrasados, analise essas etapas.
-
Verificar dados do Serviço de Catálogo
Use a Catalog Service API para confirmar se a alteração no catálogo foi armazenada com êxito.
-
VerificarSaaS Data Export
Eventos de catálogo exigem dados atuais em Catalog Service. Confirme os dois estágios do caminho de exportação:
-
Exportação do feed do Commerce — Na página Status de sincronização do feed de dados ou em
var/log/saas-export.log, confirme se os feeds Catalog Service foram exportados com êxito do Commerce. -
Sincronizar com os serviços SaaS conectados do Commerce — No Painel de Gerenciamento de Dados, Sincronização de Catálogo, ou em logs de exportação, confirme se os dados foram sincronizados com êxito no Catalog Service.
Para solucionar problemas de trabalhos de exportação e sincronização, consulte Sincronizar dados com a Exportação de Dados SaaS e Logs e solução de problemas.
-
-
Validar a configuração Adobe I/O Events
Confirme que:
- Você está conectado à organização IMS correta em Adobe Developer Console.
- O provedor Commerce Catalog Events está habilitado.
- O ambiente e o provedor esperados Commerce Catalog Events estão visíveis.
- A assinatura está ativa.
- Seu consumidor de ponto de extremidade, ação ou diário pode receber e processar eventos de teste.
-
Contate o Suporte da Adobe
Ao abrir um tíquete de suporte, selecione o motivo do problema que corresponde ao aplicativo do Adobe Commerce e inclua as seguintes informações:
- Detalhes do Serviço de catálogo (ambiente, região).
- Adobe I/O Events Detalhes da assinatura.
- Tempo aproximado e descrição de eventos ausentes.
Para obter ajuda adicional, consulte Tíquetes de suporte.