Desenvolvimento com o SAP Commerce Cloud

A estrutura de integração inclui uma camada de integração com uma API. Isso permite que você:

• conecte um sistema de eCommerce e extraia dados de produtos para AEM

• criar componentes AEM para recursos de comércio, independentemente do mecanismo de eCommerce específico

Vários componentes predefinidos AEM são fornecidos para usar a camada de integração. Atualmente, eles são:

• um componente de exibição de produto
• um carrinho de compras
• check-out

Para pesquisar, é fornecido um gancho de integração que permite usar a pesquisa AEM, a pesquisa do sistema de comércio eletrônico, uma pesquisa de terceiros (como Search & Promote) ou uma combinação desses itens.

Seleção do mecanismo de comércio eletrônico

A estrutura eCommerce pode ser usada com qualquer solução de eCommerce, o mecanismo usado precisa ser identificável por AEM:

• Os mecanismos de comércio eletrônico são serviços OSGi que oferecem suporte à interface CommerceService

  • Os mecanismos podem ser diferenciados por uma propriedade de serviço commerceProvider

• AEM suporta Resource.adaptTo() para CommerceService e Product

  • A implementação adaptTo procura uma propriedade cq:commerceProvider na hierarquia do recurso:

    • Se encontrado, o valor é usado para filtrar a pesquisa do serviço de comércio.

    • Se não for encontrado, o serviço de comércio classificado mais alto será usado.

  • Uma combinação cq:Commerce é usada para que cq:commerceProvider possa ser adicionada a recursos com tipos específicos.

• A propriedade cq:commerceProvider também é usada para fazer referência à definição de fábrica de comércio apropriada.

  • Por exemplo, uma propriedade cq:commerceProvider com o valor hybris será correlacionada à configuração OSGi para Day CQ Commerce Fatory for Hybris (com.adobe.cq.commerce.hybris.impl.HybrisServiceFactory) - onde o parâmetro commerceProvider também tem o valor hybris.

  • Aqui, outras propriedades, como Versão do catálogo, podem ser configuradas (quando apropriado e disponível).

Consulte os seguintes exemplos abaixo:

cq:commerceProvider = geometrixx	numa instalação normal AEM é necessária uma implementação específica; por exemplo, o exemplo geometrixx, que inclui extensões mínimas para a API genérica
cq:commerceProvider = hybris	implementação do hybris

Exemplo

/content/store
+ cq:commerceProvider = hybris
  + mens
    + polo-shirt-1
    + polo-shirt-2
    + employee
+ cq:commerceProvider = jcr
  + adobe-logo-shirt
    + cq:commerceType = product
    + price = 12.50
  + adobe-logo-shirt_S
    + cq:commerceType = variant
    + size = S
  + adobe-logo-shirt_XL
    + cq:commerceType = variant
    + size = XL
    + price = 14.50

Desenvolvimento para híbridos 4

A extensão hybris do eCommerce Integration Framework foi atualizada para suportar o Hybris 5, mantendo a compatibilidade retroativa com o Hybris 4.

As configurações padrão no código são ajustadas para Hybris 5.

Para desenvolver para Hybris 4 é necessário o seguinte:

• Ao chamar o maven, adicione o seguinte argumento de linha de comando ao comando

  -P hybris4

  Ele baixa a distribuição pré-configurada Hybris 4 e a incorpora ao pacote cq-commerce-hybris-server.

• No gerenciador de configuração OSGi:

  • Desative o suporte para Hybris 5 para o serviço Parser de resposta padrão.

  • Verifique se o serviço Hybris Basic Authentication Handler tem uma classificação de serviço inferior ao serviço Hybris OAuth Handler.

Tratamento de Sessão

hybris usa uma sessão do usuário para armazenar informações como o carrinho de compras do cliente. A ID da sessão é retornada de híbridos em um cookie JSESSIONID que precisa ser enviado em solicitações subsequentes para híbridos. Para evitar o armazenamento da ID da sessão no repositório, ela é codificada em outro cookie armazenado no navegador do comprador. As seguintes etapas são executadas:

• Na primeira solicitação, nenhum cookie é definido na solicitação do comprador; portanto, uma solicitação é enviada para a instância hybris para criar uma sessão.

• Os cookies de sessão são extraídos da resposta, codificados em um novo cookie (por exemplo, hybris-session-rest) e definidos na resposta ao comprador. A codificação em um novo cookie é necessária, pois o cookie original é válido somente para um determinado caminho e, de outra forma, não seria enviado de volta do navegador em solicitações subsequentes. As informações de caminho também devem ser adicionadas ao valor do cookie.

• Em solicitações subsequentes, os cookies são decodificados dos cookies hybris-session-<*xxx*> e definidos no cliente HTTP usado para solicitar dados de híbridos.

CommerceSession

• Esta sessão "possui" o carrinho de compras

  • realiza add/remove/etc

  • realiza os vários cálculos no carrinho;

    commerceSession.getProductPrice(Product product)

• Possui a localização do armazenamento para os dados order

  CommerceSession.getUserContext()

• Também possui a conexão de processamento payment

• Também possui a conexão fulfillment

Sincronização e publicação do produto

Os dados do produto que são mantidos em híbridos precisam estar disponíveis em AEM. Foi implementado o seguinte mecanismo:

• Uma carga inicial de IDs é fornecida por híbridos como um feed. Pode haver atualizações neste feed.
• os híbridos fornecerão informações de atualização por meio de um feed (que AEM pesquisas).
• Quando o AEM estiver usando dados de produto, ele enviará solicitações de volta aos híbridos para os dados atuais (solicitação de obtenção condicional usando a última data modificada).
• Em hiperbilidades é possível especificar o conteúdo do feed de forma declarativa.
• O mapeamento da estrutura do feed para o modelo de conteúdo AEM acontece no adaptador do feed no lado AEM.

• O importador (b) é usado para a configuração inicial da estrutura em árvore de páginas em AEM para catálogos.

• As alterações de catálogo em híbridos são indicadas para AEM por meio de um feed, propagando-se então para AEM (b)

  • Produto adicionado/excluído/alterado em relação à versão do catálogo.

  • Produto aprovado.

• A extensão hybris fornece um importador de pesquisas (esquema "hybris"), que pode ser configurado para importar alterações para AEM em um intervalo especificado (por exemplo, a cada 24 horas, onde o intervalo é especificado em segundos):

      http://localhost:4502/content/geometrixx-outdoors/en_US/jcr:content.json
       {
       * "jcr:mixinTypes": ["cq:PollConfig"],
       * "enabled": true,
       * "source": "hybris:outdoors",
       * "jcr:primaryType": "cq:PageContent",
       * "interval": 86400
       }
  

• A configuração do catálogo no AEM reconhece as versões do catálogo Staged e Online.

• A sincronização de produtos entre versões de catálogo exigirá uma (des)ativação da página de AEM correspondente (a, c)

  • Adicionar um produto a uma versão de catálogo Online requer a ativação da página do produto.

  • A remoção de um produto requer a desativação.

• A ativação de uma página no AEM © requer uma verificação (b) e só é possível se

  • O produto está em uma versão de catálogo Online para páginas de produtos.

  • Os produtos referenciados estão disponíveis em uma versão de catálogo Online para outras páginas (por exemplo, páginas de campanha).

• As páginas de produtos ativadas precisam acessar a versão Online dos dados do produto (d).

• A instância de publicação de AEM exige acesso a híbridos para recuperação de produtos e dados personalizados (d).

Arquitetura

Arquitetura de produtos e variáveis

Um único produto pode apresentar variações múltiplas; por exemplo, pode variar de acordo com a cor e/ou o tamanho. Um produto deve definir as propriedades que determinam a variação; chamamos estes eixos variantes.

No entanto, nem todas as propriedades são eixos variantes. As variações também podem afetar outras propriedades; por exemplo, o preço pode depender do tamanho. Estas propriedades não podem ser selecionadas pelo comprador, pelo que não são consideradas eixos variantes.

Cada produto e/ou variante é representado por um recurso e, portanto, mapeia 1:1 para um nó de repositório. É corolário que um produto e/ou variante específicos possam ser identificados exclusivamente pelo seu caminho.

O produto/recurso variante nem sempre contém os dados reais do produto. Pode ser uma representação dos dados realmente mantidos em outro sistema (como híbridos). Por exemplo, descrições de produtos, preços etc. não são armazenados em AEM, mas recuperados em tempo real do mecanismo de comércio eletrônico.

Qualquer recurso de produto pode ser representado por um Product API. A maioria das chamadas na API do produto é específica para variações (embora as variações possam herdar valores compartilhados de um ancestral), mas também há chamadas que listas o conjunto de variações ( getVariantAxes(), getVariants() etc.).

Referências do produto e dados do produto

Em geral:

• os dados do produto estão localizados em /etc

• e referências de produto em /content.

Deve haver um mapa 1:1 entre variações do produto e nós de dados do produto.

As referências de produto também devem ter um nó para cada variação apresentada - mas não há necessidade de apresentar todas as variações. Por exemplo, se um produto tem variações S, M, L, os dados do produto podem ser:

etc
|──commerce
|  |──products
|     |──shirt
|       |──shirt-s
|       |──shirt-m
|       |──shirt-l

Enquanto um catálogo "Grande e Alto" pode ter apenas:

content
|──big-and-tall
|  |──shirt
|     |──shirt-l

Por fim, não há necessidade de usar os dados do produto. É possível colocar todos os dados do produto sob as referências no catálogo; mas não é possível ter vários catálogos sem duplicar todos os dados do produto.

API

com.adobe.cq.commerce.api.Interface do produto

public interface Product extends Adaptable {

    public String getPath();            // path to specific variation
    public String getPagePath();        // path to presentation page for all variations
    public String getSKU();             // unique ID of specific variation

    public String getTitle();           // shortcut to getProperty(TITLE)
    public String getDescription();     // shortcut to getProperty(DESCRIPTION)
    public String getImageUrl();        // shortcut to getProperty(IMAGE_URL)
    public String getThumbnailUrl();    // shortcut to getProperty(THUMBNAIL_URL)

    public <T> T getProperty(String name, Class<T> type);

    public Iterator<String> getVariantAxes();
    public boolean axisIsVariant(String axis);
    public Iterator<Product> getVariants(VariantFilter filter) throws CommerceException;
}

com.adobe.cq.commerce.api.VariantFilter

/**
 * Interface for filtering variants and AxisFilter provided as common implementation
 *
 * The <code>VariantFilter</code> is used to filter variants,
 * e.g. when using {@link Product#getVariants(VariantFilter filter)}.
 */
public interface VariantFilter {
    public boolean includes(Product product);
}

/**
 * A {@link VariantFilter} for filtering variants by the given
 * axis and value. The following example returns a list of
 * variant products that have a value of <i>blue</i> on the
 * <i>color</i> axis.
 *
 * <p>
 * <code>product.getVariants(new AxisFilter("color", "blue"));</code>
 */
public class AxisFilter implements VariantFilter {

    private String axis;
    private String value;

    public AxisFilter(String axis, String value) {
        this.axis = axis;
        this.value = value;
    }

    /**
     * {@inheritDoc}
     */
    public boolean includes(Product product) {
        ValueMap values = product.adaptTo(ValueMap.class);

        if(values != null) {
            String v = values.get(axis, String.class);

            return v != null && v == value;
        }

        return false;
    }
}

• Mecanismo geral de Armazenamento

  • Os nós do produto são nt:unstructured.

  • Um nó de produto pode ser:

    • Uma referência, com os dados do produto armazenados em outro lugar:

      • As referências do produto contêm uma propriedade productData, que aponta para os dados do produto (normalmente em /etc/commerce/products).

      • Os dados do produto são hierárquicos; os atributos do produto são herdados dos ancestrais de um nó de dados do produto.

      • As referências de produtos também podem conter propriedades locais, que substituem as especificadas nos dados de seus produtos.

    • Um produto em si:

      • Sem uma propriedade productData.

      • Um nó de produto que contém todas as propriedades localmente (e não contém uma propriedade productData) herda os atributos de produto diretamente de seus próprios ancestrais.

• Estrutura do produto AEM-genérico

  • Cada variante deve ter seu próprio nó de folha.

  • A interface do produto representa produtos e variantes, mas o nó do repositório relacionado é específico sobre o qual ele é.

  • O nó product descreve os atributos do produto e os eixos variantes.

Exemplo

+ banyan_shirt
    - cq:commerceType = product
    - cq:productAttributes = [jcr:title, jcr:description, size, price, color]
    - cq:productVariantAxes = [color, size]
    - jcr:title = Banyan Shirt
    - jcr:description = Flowery, all-cotton shirt.
    - price = 14.00
    + banyan_shirt_s
        - cq:commerceType = variant
        - size = S
        + banyan_shirt_s_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_s_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_m
        - cq:commerceType = variant
        - size = M
        + banyan_shirt_m_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_m_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_l
        - cq:commerceType = variant
        - size = L
        + banyan_shirt_l_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_l_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_xl
        - cq:commerceType = variant
        - size = XL
        - price = 18.00

Arquitetura do carrinho de compras

Componentes

• O carrinho de compras pertence ao CommerceSession:

  • O CommerceSession executa add/remove/etc.
  • O CommerceSession também executa os vários cálculos no carrinho. "

• Embora não esteja diretamente relacionado ao carrinho, o CommerceSession também deve fornecer informações de preços do catálogo (já que ele possui preços)

  • O preço pode ter vários modificadores:

    • Descontos de quantidade.
    • Moedas diferentes.
    • IVA e sem IVA.

  • Os modificadores são completamente abertos com a seguinte interface:

    • int CommerceSession.getQuantityBreakpoints(Product product)
    • String CommerceSession.getProductPrice(Product product)

Armazenamento

• Armazenamento

  • No caso hybris, o servidor hybris é proprietário do carrinho.
  • No AEM-genérico, os carrinhos de memória são armazenados no ClientContext .

Personalização

• A personalização deve ser sempre conduzida pelo ClientContext.

• Um ClientContext /version/ do carrinho é criado em todos os casos:

  • Os produtos devem ser adicionados usando o método CommerceSession.addCartEntry().

• A seguir está um exemplo de informações do carrinho no carrinho de ClientContexts:

Arquitetura do checkout

Dados do carrinho e pedido

O CommerceSession possui os três elementos:

1. Conteúdo do carrinho

2. Preços

3. Os detalhes do pedido

4. Conteúdo do carrinho

   O schema de conteúdo do carrinho é corrigido pela API:

   public void addCartEntry(Product product, int quantity);
   public void modifyCartEntry(int entryNumber, int quantity);
   public void deleteCartEntry(int entryNumber);
   

5. Preços

   O schema de preços também é corrigido pela API:

   public String getCartPreTaxPrice();
   public String getCartTax();
   public String getCartTotalPrice();
   public String getOrderShipping();
   public String getOrderTotalTax();
   public String getOrderTotalPrice();
   

6. Detalhes do pedido

   No entanto, os detalhes do pedido são e não corrigidos pela API:

   public void updateOrderDetails(Map<String, String> orderDetails);
   public Map<String, String> getOrderDetails();
   public void submitOrder();
   

Cálculos de Envio

• Os formulários de pedido geralmente precisam apresentar várias opções de envio (e preços).

• Os preços podem se basear em itens e detalhes do pedido, como peso e/ou endereço do delivery.

• O CommerceSession tem acesso a todas as dependências, portanto, ele pode ser tratado de maneira semelhante ao preço do produto:

  • O CommerceSession possui preços de remessa.
  • Pode recuperar/atualizar detalhes do delivery usando updateOrder(Map<String, Object> delta)

Processamento de pagamento

• O CommerceSession também possui a conexão de processamento de pagamento.

• Os implementadores precisam adicionar chamadas específicas (ao serviço de processamento de pagamentos escolhido) à implementação CommerceSession.

Preenchimento do pedido

• O CommerceSession também possui a conexão de execução.
• Os implementadores precisarão adicionar chamadas específicas (ao serviço de processamento de pagamentos escolhido) à implementação CommerceSession.

Definição de pesquisa

Seguindo o modelo padrão de API de serviço, o projeto de eCommerce fornece um conjunto de APIs relacionadas à pesquisa que podem ser implementadas por mecanismos de comércio individuais.

O projeto eCommerce contém um componente de pesquisa padrão, localizado em:

/libs/commerce/components/search

Isso usa a API de pesquisa para query do mecanismo de comércio selecionado (consulte Seleção do mecanismo de comércio eletrônico):

API de pesquisa

Há várias classes genéricas/auxiliares fornecidas pelo projeto principal:

1. CommerceQuery

   É usado para descrever um query de pesquisa (contém informações sobre o texto do query, a página atual, o tamanho da página, a classificação e as facetas selecionadas). Todos os serviços de comércio eletrônico que implementam a API de pesquisa receberão instâncias desta classe para realizar sua pesquisa. Um CommerceQuery pode ser instanciado a partir de um objeto de solicitação ( HttpServletRequest).

2. FacetParamHelper

   É uma classe de utilitário que fornece um método estático - toParams - que é usado para gerar GET strings de parâmetro de uma lista de aspectos e um valor alternado. Isso é útil na interface do usuário, onde é necessário exibir um hiperlink para cada valor de cada aspecto, de modo que quando o usuário clica no hiperlink o respectivo valor é alternado (isto é, se foi selecionado, ele é removido do query, caso contrário é adicionado). Isso cuida de toda a lógica de lidar com facetas múltiplas/de valor único, valores sobrepostos etc.

O ponto de entrada da API de pesquisa é o método CommerceService#search que retorna um objeto CommerceResult. Consulte a Documentação da API para obter mais informações sobre este tópico.

Integração de usuários

A integração é fornecida entre AEM e vários sistemas de comércio eletrônico. Isso requer uma estratégia para sincronizar compradores entre os vários sistemas, de modo que o código específico do AEM tenha que saber apenas sobre AEM e vice-versa:

• Autenticação

  AEM é considerado o front-end da Web only e, portanto, realiza tudo autenticação.

• Contas em Hybris

  AEM cria uma conta correspondente (secundária) em híbridos para cada comprador. O nome de usuário desta conta é igual ao nome de usuário AEM. Uma senha criptograficamente aleatória é gerada automaticamente e armazenada (criptografada) no AEM.

Usuários preexistentes

Um front-end AEM pode ser posicionado na frente de uma implementação de hybris existente. Além disso, é possível adicionar um mecanismo hybris a uma instalação AEM existente. Para fazer isso, os sistemas devem ser capazes de lidar com os usuários existentes em qualquer sistema:

• AEM -> híbridos

  • Ao fazer logon em híbridos, se o usuário AEM ainda não existir:

    • criar um novo usuário hybris com uma senha aleatória criptografada
    • armazene o nome de usuário hybris no diretório de usuário do AEM

  • Consulte: com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()

• hybris -> AEM

  • Ao fazer logon no AEM, se o sistema reconhecer o usuário:

    • tentativa de fazer logon em hiperlinks com o nome de usuário/pwd fornecido
    • se bem-sucedido, crie o novo usuário no AEM com a mesma senha (sal específico para AEM resultará em hash específico para AEM)

  • O algoritmo acima é implementado em um Sling AuthenticationInfoPostProcessor

    • Consulte: com.adobe.cq.commerce.hybris.impl.user.LazyUserImporter.java

Personalizando o Processo de Importação

Para aproveitar a funcionalidade existente, seu manipulador de importação personalizado:

• tem que implementar a interface ImportHandler

• pode estender DefaultImportHandler.

/**
 * Services implementing the <code>ImportHandler</code> interface are
 * called by the {@link HybrisImporter} to create actual commerce entities
 * such as products.
 */
public interface ImportHandler {

  /**
  * Not used.
  */
  public void createTaxonomie(ImporterContext ctx);

  /**
  * Creates a catalog with the given name.
  * @param ctx   The importer context
  * @param name  The catalog's name
  * @return Path of created catalog
  */
  public String createCatalog(ImporterContext ctx, String name) throws Exception;

  /**
  * Creates a product from the given values.
  * @param ctx                The importer context
  * @param values             The product's properties
  * @param parentCategoryPath The containing category's path
  * @return Path of created product
  */
  public String createProduct(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;

  /**
  * Creates a variant product from the given values.
  * @param ctx             The importer context
  * @param values          The product's properties
  * @param baseProductPath The base product's path
  * @return Path of created product
  */
  public String createVariantProduct(ImporterContext ctx, ValueMap values, String baseProductPath) throws Exception;

  /**
  * Creates an asset for a product. This is usually a product
  * image.
  * @param ctx             The importer context
  * @param values          The product's properties
  * @param baseProductPath The product's path
  * @return Path of created asset
  */
  public String createAsset(ImporterContext ctx, ValueMap values, String productPath) throws Exception;

  /**
  * Creates a category from the given values.
  * @param ctx           The importer context
  * @param values        The category's properties
  * @param parentPath    Path of parent category or base path of import in case of root category
  * @return Path of created category
  */
  public String createCategory(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;
}

Para que seu manipulador personalizado seja reconhecido pelo importador, ele deve especificar a propriedade service.rankingcom um valor superior a 0; por exemplo.

@Component
@Service
@Property(name = "service.ranking", value = 100)
public class MyImportHandler extends DefaultImportHandler
{
...
}