O desenvolvimento de projetos do AEM Commerce com base na Commerce Integration Framework (CIF) para o AEM as a Cloud Service segue as mesmas regras e práticas recomendadas de outros projetos AEM no AEM as a Cloud Service. Leia primeiro estes itens:
Um ambiente de desenvolvimento local é recomendado para trabalhar com projetos da CIF. O complemento CIF disponibilizado para ambientes do AEM as a Cloud Service também está disponível para desenvolvimento local. Ele pode ser baixado no Portal de distribuição de software.
O complemento CIF é fornecido como um arquivo de recursos Sling. O arquivo zip disponível no Portal de distribuição de software inclui dois arquivos de recursos Sling, um para o autor no AEM e outro para instâncias de publicação do AEM.
Novo no AEM as a Cloud Service? Consulte um guia mais detalhado para configurar um ambiente de desenvolvimento local usando o AEM como um SDK Cloud Service.
Devem ser instalados:
É possível baixar o complemento CIF como um arquivo zip no Portal de distribuição de software. O arquivo zip contém o suplemento CIF como Arquivo de recursos Sling, ele não é um pacote AEM. Observe que o acesso às listagens do SDK está limitado aos que têm uma licença do AEM as a Cloud Service.
Use sempre a versão mais recente do complemento CIF.
Para o desenvolvimento local do complemento CIF usando o AEM as a Cloud Service, siga estas etapas:
Obtenha o SDK do AEM as a Cloud Service mais recente
Descompacte o AEM .jar para criar a pasta crx-quickstart
e execute:
java -jar <jar name> -unpack
Crie uma pasta crx-quickstart/install
Copie o arquivo de recursos Sling correto do complemento CIF na pasta crx-quickstart/install
.
O arquivo zip do complemento CIF contém dois arquivos .far
de recursos Sling. Use o arquivo correto para autor ou publicação no AEM, dependendo de como você planeja executar o SDK do AEM as a Cloud Service local.
Crie uma variável de ambiente do sistema operacional local com o nome COMMERCE_ENDPOINT
mantendo o ponto de extremidade GraphQL da Magento.
Exemplo para Mac OSX:
export COMMERCE_ENDPOINT=https://demo.magentosite.cloud/graphql
Exemplo para Windows:
set COMMERCE_ENDPOINT=https://demo.magentosite.cloud/graphql
Essa variável é usada pelo AEM para se conectar ao seu sistema de comércio. Além disso, o add-on CIF inclui um proxy reverso local para disponibilizar o ponto final Magento GraphQL localmente. Isso é usado pelas ferramentas de criação CIF (console do produto e seletores) e para os componentes CIF do cliente que fazem chamadas diretas do GraphQL.
Essa variável também deve ser configurada para o ambiente do AEM as a Cloud Service. Para obter mais informações sobre variáveis, consulte Configuração do OSGi para AEM como Cloud Service.
(Opcional) Para ativar os recursos de catálogo preparados, é necessário criar um token de integração para a instância do Magento. Siga as etapas em Introdução para criar o token.
Defina um segredo OSGi com o nome COMMERCE_AUTH_HEADER
para o seguinte valor:
Authorization: Bearer <Access Token>
Para obter mais informações sobre segredos, consulte Configuração do OSGi para AEM como um Cloud Service.
Inicie o SDK do AEM as a Cloud Service
Verifique a configuração por meio do console OSGI: http://localhost:4502/system/console/osgi-installer
. A lista deve incluir os pacotes relacionados ao complemento CIF, o pacote de conteúdo e as configurações OSGI, conforme definido no arquivo de modelo de recurso.
Há duas maneiras de inicializar o projeto da CIF para o AEM as a Cloud Service.
O Arquétipo de projeto do AEM é a principal ferramenta para inicializar um projeto pré-configurado e começar a usar a CIF. Os Componentes principais da CIF e todas as configurações necessárias podem ser incluídos em um projeto gerado com uma opção adicional.
Use o Arquétipo de projeto do AEM 24 ou posterior para gerar o projeto.
Consulte as instruções de uso do Arquétipo de projeto do AEM sobre como gerar um projeto do AEM. Para incluir a CIF no projeto, use a opção includeCommerce
.
Por exemplo:
mvn -B archetype:generate \
-D archetypeGroupId=com.adobe.granite.archetypes \
-D archetypeArtifactId=aem-project-archetype \
-D archetypeVersion=24 \
-D aemVersion=cloud \
-D appTitle="My Site" \
-D appId="mysite" \
-D groupId="com.mysite" \
-D frontendModule=general \
-D includeExamples=n \
-D includeCommerce=y
Os Componentes principais da CIF podem ser utilizados em qualquer projeto mediante o pacote all
fornecido ou de maneira separada, utilizando o pacote de conteúdo da CIF e os pacotes OSGI relacionados. Para adicionar os Componentes principais da CIF manualmente a um projeto, use as seguintes dependências:
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>core-cif-components-apps</artifactId>
<type>zip</type>
<version>x.y.z</version>
</dependency>
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>core-cif-components-core</artifactId>
<version>x.y.z</version>
</dependency>
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>graphql-client</artifactId>
<version>x.y.z</version>
</dependency>
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>magento-graphql</artifactId>
<version>x.y.z</version>
</dependency>
Uma segunda opção para iniciar um projeto da CIF é clonar e usar a loja de referência AEM Venia. A loja de referência AEM Venia é um exemplo de aplicativo de vitrine de referência que demonstra o uso dos Componentes principais da CIF para o AEM. Ela serve como um conjunto de exemplos de práticas recomendadas, bem como um possível ponto de partida para desenvolver sua própria funcionalidade.
Para começar a usar a loja de referência Venia, basta clonar o repositório Git e personalizar o projeto de acordo com suas necessidades.
O projeto da loja de referência Venia contém dois perfis de construção para o AEM as a Cloud Service e o AEM 6.5. Verifique o arquivo readme.md do projeto para ver como eles são usados.