Commerce Services Connector
Alguns recursos do Adobe Commerce e do Magento Open Source são viabilizados pelo Commerce Services e implantados como SaaS (software como serviço). Para usar esses serviços, você deve conectar sua instância do Commerce usando chaves de API de sandbox e produção e especificar o espaço de dados na configuração. Você só precisa configurar a conexão uma vez para cada instância.
Somente o proprietário da licença Commerce pode gerar essas chaves de API. Se você não for o proprietário da licença, solicite as chaves da pessoa ou da equipe que é proprietária da licença da Commerce para sua loja.
Serviços disponíveis availableservices
Veja a seguir uma lista dos recursos do Commerce que você pode acessar por meio do Commerce Services Connector:
Arquitetura
Em um nível superior, o Commerce Services Connector é composto dos seguintes elementos principais:
As seções a seguir discutem cada um desses elementos com mais detalhes.
Credenciais apikey
As chaves de API de sandbox e produção são geradas a partir da conta Commerce do proprietário da licença. A conta do Commerce é identificada por um identificador exclusivo Commerce (MageID). O proprietário da licença da organização do comerciante pode gerar chaves de API para serviços como Recomendações de produto ou Live Search, desde que a conta esteja em bom estado.
As chaves podem ser compartilhadas com base no "conhecimento necessário" com o integrador de sistemas ou a equipe de desenvolvimento que gerencia projetos e ambientes em nome do titular da licença. Os desenvolvedores aos quais o proprietário da licença concedeu Shared Access não podem gerar as chaves em nome do proprietário da licença, mesmo que a organização do comerciante esteja presente na lista suspensa Switch Accounts em sua conta.
Além disso, os integradores de soluções estão autorizados a usar o Commerce Services. Se você for um integrador de soluções, o signatário do contrato de parceiro Commerce deve gerar as chaves de API.
Os identificadores de chave Produção e Sandbox referem-se a ambientes de espaço de dados SaaS onde Commerce Services armazena dados (não a seus ambientes Adobe Commerce). Você pode usar o mesmo conjunto de chaves de API em seus ambientes Adobe Commerce locais, de desenvolvimento, de preparo e de produção — o que importa é que você cole o par de chaves correto para o espaço de dados configurado.
O proprietário da licença normalmente é o contato principal na conta da Adobe Commerce e nem sempre é o mesmo Proprietário do projeto Adobe Commerce na infraestrutura em nuvem.
Gerar as chaves de API de produção e sandbox genapikey
-
Faça logon em sua conta do Commerce em https://account.magento.com.
-
Na guia Magento, selecione Portal de API na barra lateral.
-
No menu Ambiente, selecione Produção ou Sandbox.
-
Insira um nome na seção Chaves de API e clique em Adicionar novo para abrir a caixa de diálogo para baixar a nova chave.
note warning WARNING Você pode copiar ou baixar a chave privada apenas uma vez. Armazene-o com segurança. -
Clique em Baixar para salvar a chave privada e fechar a caixa de diálogo.
-
Repita as etapas acima para cada ambiente (produção e sandbox).
A seção Chaves de API agora exibe suas chaves de API (Públicas). Você precisa de todas as quatro chaves (tanto as chaves de produção quanto de sandbox, Público+Privado) ao selecionar ou criar um projeto SaaS em qualquer um dos ambientes ou instalações associados à licença.
Configuração SaaS saasenv
Commerce instâncias devem ser configuradas com um projeto SaaS e um espaço de dados SaaS para que Commerce Services possa enviar os dados para o local correto. Um projeto SaaS agrupa todos os espaços de dados SaaS. Os espaços de dados SaaS são usados para coletar e armazenar dados que permitem que o Commerce Services funcione. Alguns desses dados podem ser exportados da instância Commerce e outros podem ser coletados do comportamento do comprador na loja. Esses dados são mantidos para proteger o armazenamento na nuvem.
Para Product Recommendations e Live Search, o espaço de dados SaaS contém dados de catálogo e comportamentais. Você pode apontar uma instância Commerce para um espaço de dados SaaS ao selecioná-la na configuração Commerce.
Se não conseguir encontrar campos de configuração do Live Search em Admin, verifique se você inseriu o par de chaves de API correto para o espaço de dados selecionado (espaços de dados de produção usam chaves de produção; o teste de espaços de dados usa chaves de sandbox). Se você configurar chaves incorretas, os serviços SaaS, como o Live Search, não estarão disponíveis nesse ambiente do Adobe Commerce.
Excluir uma chave de API delapikey
Antes de excluir uma chave de API, gere e armazene com segurança uma chave de substituição. Atualize todas as integrações para usar a nova chave e confirme se os serviços dependentes estão funcionando como esperado.
Se você não vir os campos de configuração Live Search no Painel de administração, confirme se inseriu a chave de API SaaS correta para esse ambiente. Use a chave SaaS de produção para o espaço de dados de produção e a chave de preparação para o espaço de dados de preparação. Se uma chave errada for configurada, os serviços SaaS (incluindo Live Search) não estarão disponíveis em seu ambiente Adobe Commerce.
Na chave de API a ser removida, clique em Delete. Quando solicitado, confirme a operação para remover permanentemente a chave.
Provisionamento de espaço de dados SaaS
Todos os comerciantes do Adobe Commerce podem acessar um espaço de dados de produção e dois espaços de dados de teste por projeto SaaS.
Você pode usar os espaços de dados de teste em ambientes de não produção, mas evitar usar o mesmo espaço de dados em vários ambientes ao mesmo tempo. Se quiser mover um espaço de dados de teste para um ambiente diferente, execute uma limpeza de dados antes de selecioná-lo e configurá-lo no novo ambiente.
Para projetos da Adobe Commerce Cloud Pro com vários ambientes de preparo, você pode solicitar espaços de dados de teste adicionais para cada ambiente de preparo enviando uma solicitação de suporte. No entanto, se você tiver apenas um ambiente de preparo e exigir espaços de dados de teste adicionais, terá as seguintes opções:
-
Entre em contato com a equipe de Sucesso do cliente ou com o Gerente de sucesso do cliente designado para solicitar um ambiente de preparo adicional.
-
Envie uma solicitação de suporte para solicitar o espaço de dados de teste adicional e indicar a justificativa comercial para o espaço de dados extra. Esta solicitação está sujeita a aprovação.
Os clientes do Magento Open Source que usam os Serviços de pagamento da Adobe também podem solicitar um espaço de dados adicional. Entre em contato com a equipe de Pagamentos para obter aprovação prévia dos espaços de dados adicionais antes de enviar uma Solicitação de suporte para solicitar o espaço de dados de teste.
Os clientes que possuem vários projetos na nuvem ou instalações locais (live/production) também podem solicitar espaços de dados adicionais de produção e teste para cada projeto ou instância por enviar uma solicitação de suporte.
Selecionar ou criar um projeto SaaS createsaasenv
Para selecionar ou criar um projeto SaaS, solicite as Commerce chaves de API ao proprietário da licença Commerce da sua loja:
-
Na barra lateral Admin, vá para System > Services > Commerce Services Connector.
Se você não vir a seção Commerce Services Connector, instale os módulos Commerce do Commerce serviço desejado e verifique se o pacote
magento/module-services-idestá instalado. -
Nas seções Sandbox API Keyse_Production API Keys_, cole seus valores de chave.
- As chaves privadas devem incluir
-----BEGIN PRIVATE KEY-----no início da chave e-----END PRIVATE KEY-----no final da chave. - Se você não tiver uma cópia das chaves reais, peça ao proprietário da licença para conectá-las e, em seguida, conecte os valores à configuração.
Não cole valores de chave copiados de um backup ou instantâneo do banco de dados. Quando a configuração é salva, uma camada adicional de criptografia é aplicada e as chaves não funcionarão.
- As chaves privadas devem incluir
-
Clique em Salvar.
Qualquer projeto SaaS associado às suas chaves é exibido no campo Projeto da seção Identificador SaaS.
-
Se não existirem projetos SaaS, clique em Criar projeto. Em seguida, no campo Projeto, digite um nome para o projeto SaaS.
Para evitar confusão, não use um Serviço Commerce específico como o nome do seu projeto (por exemplo, Live Search, Recomendações de Produto ou Conexão de Dados). A menos que sua licença tenha sido provisionada para vários projetos SaaS, você poderá usar o mesmo projeto SaaS para vários serviços.
-
Selecione o Espaço de Dados a ser usado para a configuração atual do seu repositório Commerce.
Se você tiver instâncias separadas para integrar com os Serviços Commerce, envie um tíquete de Suporte para solicitar um novo projeto SaaS para cada instância adicional. Depois que o Suporte criar o projeto SaaS, configure a integração para a instância usando as mesmas chaves de API e selecionando o novo projeto SaaS para o espaço de dados.
Para alterar os nomes do projeto SaaS ou do espaço de dados, clique em Renomear. Alterar o nome não afeta seu serviço porque o nome é apenas um rótulo que ajuda a identificar e diferenciar entre projetos e espaços de dados.
Organização IMS (opcional) organizationid
Para conectar sua instância do Adobe Commerce à Adobe Experience Platform, faça logon em sua conta da Adobe usando sua Adobe ID. Depois de fazer logon, a organização IMS associada à sua conta da Adobe é exibida nesta seção.
Exportação de dados SaaS
Quando a instância do Commerce é conectada com êxito ao Commerce Services, o processo de exportação de dados SaaS exporta os dados do Commerce do servidor Commerce para o Commerce SaaS Services para que ele possa ser sincronizado com os Commerce Services conectados. No Administrador, você pode verificar o status da sincronização usando o painel de Gerenciamento de Dados. Para obter detalhes, consulte o Guia de Exportação de Dados SaaS.