Desenvolver o AEM Commerce para o AEM as a Cloud Service develop

O desenvolvimento de projetos do AEM Commerce, com base no Commerce integration framework (CIF) for AEM as a Cloud Service, segue as mesmas regras e práticas recomendadas de outros projetos do AEM no AEM as a Cloud Service. Revise o seguinte primeiro:

Desenvolvimento local com o AEM as a Cloud Service SDK local

Um ambiente de desenvolvimento local é recomendado para trabalhar com projetos da CIF. O complemento do CIF fornecido para o 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.

Software necessário required-software

Devem ser instalados:

Acesso ao complemento do CIF accessing-add-on

O complemento CIF pode ser baixado como um arquivo zip no Portal de distribuição de software. O arquivo zip contém o complemento CIF como arquivo de recursos Sling, não é um pacote AEM. As listagens do SDK podem ser acessadas com uma licença do AEM as a Cloud Service.

TIP
Use sempre a versão mais recente do complemento CIF.

Configuração local local-setup

Para o desenvolvimento local do complemento do CIF usando o AEM as a Cloud Service SDK, siga estas etapas:

  1. Obtenha o AEM as a Cloud Service SDK mais recente.

  2. Descompacte o AEM .jar para criar a pasta crx-quickstart. Execute o seguinte comando:

    code language-bash
    java -jar <jar name> -unpack
    
  3. Criar uma pasta crx-quickstart/install.

  4. 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 de recursos Sling .far.
    • 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.
  5. Crie uma variável de ambiente do sistema operacional local com o nome COMMERCE_ENDPOINT que contenha o ponto de extremidade do Adobe Commerce GraphQL.

    • Essa variável é usada pelo AEM para se conectar ao sistema de comércio. O complemento CIF inclui um proxy reverso local para disponibilizar o endpoint do Commerce GraphQL localmente. Esse proxy é usado pelas ferramentas de criação do CIF (console do produto e seletores) e para os componentes do lado do cliente do CIF que fazem chamadas diretas de 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 Configurar OSGi para AEM as a Cloud Service.

    • Exemplo em macOS:

      code language-bash
      export COMMERCE_ENDPOINT=https://<yourcommercesystem>/graphql
      
    • Exemplo no Windows:

      code language-bash
      set COMMERCE_ENDPOINT=https://<yourcommercesystem>/graphql
      
  6. (Opcional) Para ativar recursos de catálogo em etapas, você deve criar um token de integração para sua instância do Adobe Commerce. Siga as etapas em Introdução para criar o token.

    • Defina um segredo OSGi com o nome COMMERCE_AUTH_HEADER com o seguinte valor:

      code language-xml
      Authorization: Bearer <Access Token>
      
    • Para obter mais informações sobre segredos, consulte Configurar OSGi para AEM as a Cloud Service.

  7. Inicie o AEM as a Cloud Service SDK.

NOTE
Inicie o AEM as a Cloud Service SDK na mesma janela de terminal em que a variável de ambiente foi definida na etapa 5. Se você iniciá-lo em uma janela de terminal separada ou clicando duas vezes no arquivo .jar, verifique se a variável de ambiente está visível.

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 do CIF, o pacote de conteúdo e as configurações OSGi, conforme definido no arquivo de modelo de recurso.

Configuração do projeto project

Há duas maneiras de Bootstrap seu projeto do CIF para o AEM as a Cloud Service.

Usar o Arquétipo de projeto do AEM project-archetype

O Arquétipo de projeto do AEM é a principal ferramenta para o Bootstrap, um projeto pré-configurado para começar a usar o 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.

TIP
Sempre use a versão mais recente do Arquétipo de Projetos AEM 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 CIF no projeto, use a opção includeCommerce.

Por exemplo:

mvn -B org.apache.maven.plugins:maven-archetype-plugin:3.2.1:generate \
 -D archetypeGroupId=com.adobe.aem \
 -D archetypeArtifactId=aem-project-archetype \
 -D archetypeVersion=35 \
 -D appTitle="My Site" \
 -D appId="mysite" \
 -D groupId="com.mysite" \
 -D includeCommerce=y

Os Componentes principais do CIF podem ser usados em qualquer projeto incluindo o pacote all fornecido ou individualmente usando o pacote de conteúdo do CIF e os pacotes OSGi relacionados. Para adicionar manualmente os Componentes principais do CIF 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-config</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>

Usar a loja de referência AEM Venia venia-reference

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 e um possível ponto de partida para desenvolver sua própria funcionalidade.

Para começar a usar a loja de referência Venia, clone o repositório Git e comece a personalizar o projeto de acordo com suas necessidades.

NOTE
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 ele é usado.

Recursos adicionais additional-resources

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab