Configuração do cartucho

Para configurar a integração SalesForce, você precisa:

  1. Configurar o cartucho base (quando aplicável);
  2. Copiar os cartuchos;
  3. Compilar os cartuchos;
  4. Enviar os cartuchos;
  5. Configurar o caminho dos cartuchos;
  6. Importar os metadados;
  7. Visão geral dos atributos personalizados adicionados aos Objetos do Sistema.

1. Configuração básica

ℹ️

Se você estiver adicionando o Gateway de Pagamento a um projeto personalizado, pule esta etapa e vá para a próxima. Esta etapa destina-se a projetos iniciais partindo do SFRA básico.

Para compilar corretamente o código front-end da Braspag, é necessário ter uma cópia do SFRA. O pacote pode ser baixado diretamente do repositório oficial da Salesforce. No entanto, para facilitar esse processo, já incluímos uma versão básica do SFRA junto ao pacote do cartucho Braspag.

Após descompactar o pacote do SFRA, atualize o caminho para o cartucho base (app_storefront_base) no arquivo package.json do pacote Braspag, apontando-o para o diretório real onde o SFRA foi instalado.

Exemplo:


    "paths": { 

        "BaseCartridge": "./cartridges/app_storefront_base" 

    } 

2. Copiar os cartuchos

Dois cartuchos dão suporte a esta integração:

  1. braspag_changes_sfra: cartucho de referência para modificar trechos de código em seu cartucho de personalização base.

Se você estiver adicionando a Braspag a um projeto personalizado, use este cartucho como referência para aplicar alterações em seus cartuchos personalizados. Caso contrário, se você estiver criando um projeto do zero, basta copiar este cartucho para a pasta do seu projeto.

  1. int_braspag: cartucho responsável por fornecer suporte para a Braspag como novo Processador de Pagamento para o Salesforce Commerce Cloud, com todas as funcionalidades relacionadas. Copie-o para a pasta do seu projeto.

Depois de copiado, execute npm install ou yarn install em um console executando na pasta do SFRA.

3. Complicar e testar os cartuchos

Após executar com sucesso o comando de instalação, execute npm run build ou yarn build para compilar o código da loja virtual na pasta storefront-reference-architecture.

Acesse a pasta raiz do repositório e execute npm run build ou yarn build.

Para os testes, acesse a pasta raiz do repositório e execute npm run test ou yarn run test.

4. Enviar os cartuchos

Envie os cartuchos pelo Visual Studio Code, usando o plugin Prophet.

  1. Instale o plugin Prophet no Visual Studio Code.
  2. Abra a pasta do seu projeto no VS Code.
  3. Na raiz do diretório de trabalho, crie um arquivo chamado dw.json e cole o código abaixo, preenchendo-o conforme as informações do seu ambiente:
{ 

    "hostname": "your-sandbox-hostname.demandware.net", 

    "username": "yourlogin", 

    "password": "yourpassword", 

    "code-version": "version_code_to_be_uploaded_to" 

} 
  1. Pressione F1 > Prophet: Enable Upload e então pressione Enter.
  2. Pressione CTRL + SHIFT + U. Na lista suspensa, selecione a opção Prophet Uploader e verifique se todos os cartuchos foram enviados com sucesso para sua instância do SFCC.

5. Configurar o caminho dos cartuchos

Acesse Business Manager > Administration > Sites > Manage Sites.

Em seguida, clique no nome do seu site:

Vá para a guia Configurações e adicione os cartuchos da Braspag no campo Cartridges, de acordo com o seu projeto:

6. Importar metadados

Os metadados/site-import estão localizados na pasta raiz do repositório da Braspag.

Crie um arquivo zip para a pasta site-import.

Se você quiser testar o cartucho, pode usar os dados de teste disponíveis na pasta metadata_demo. Isso é útil para ambientes de desenvolvimento e preparação, mas não para produção. Para usá-lo, importe também a pasta metadata_demo seguindo as mesmas etapas da pasta site-import.

Importe o arquivo de metadados indo para Business Manager > Administration > Site Development > Site Import & Export:

Faça upload do arquivo zip:

Importe o arquivo zip:

7. Atributos personalizados

Alguns atributos personalizados foram adicionados em 6 Objetos do Sistema. Veja abaixo a lista:

1. SitePreferences

GroupIdNameDescriptionType
BRASPAGbraspagBoletoProviderProvedor de Pagamento BoletoO provedor de pagamento a ser usado para transações de boletoenum-of-string
BRASPAGbraspagBoletoDaysToCancelDias para Cancelar Boleto BraspagDias para Cancelar Boleto Braspagint
BRASPAGbraspagCreditProviderProvedor de Pagamento de CréditoO provedor de pagamento a ser usado para transações com cartão de créditoenum-of-string
BRASPAGbraspagEnabledHabilitar Pagamento BraspagControle Braspag para habilitar ou desabilitarboolean
BRASPAGbraspagEnablePaymentCaptureOnCheckoutHabilitar Captura de Pagamento durante o CheckoutQuando habilitado o pagamento será capturado durante o checkout assim que for autorizado. Caso contrário, durante o checkout apenas a autorização do pagamento será feita.boolean
BRASPAGbraspagMerchantIDID do comerciante usado para interagir com APIs externasID do comerciante que será recebido da Braspag (isso será usado para ter acesso à biblioteca js da Braspag).`string
BRASPAGbraspagMerchantKeyChave do Comerciante usada para interagir com APIs externasChave do comerciante que será recebida da Braspag (isso será usado para ter acesso à biblioteca js da Braspag).string
BRASPAGbraspagPixProviderProvedor de Pagamento PixO provedor de pagamento a ser usado para transações Pixenum-of-string
BRASPAGbraspagDebitProviderProvedor de Pagamento de débitoO provedor de pagamento a ser usado para transações com cartão de débitoenum-of-string
BRASPAGbraspagClientIdID do clienteID do cliente para serviço de tokenstring
BRASPAGbraspagClientSecretSecret do clienteSecret do cliente para serviço de tokenstring
BRASPAGbraspagEstablishmentCodeCódigo de estabelecimentoCielo E-Commerce 3.0 ou Código de Estabelecimento Getnet, ou PV na Redestring
BRASPAGbraspagMerchantNameNome do comercianteNome do estabelecimento registrado no adquirentestring
BRASPAGbraspagMCCMCCCódigo de categoria do estabelecimentostring
BRASPAGbraspagSoftDescriptorSoftDescriptorUsar apenas letras, números e espaços. Tamanho máximo de 13 caracteres.string
BraspagAntifraudbraspagEnableAntiFraudHabilitar Antifraude BraspagHabilitar antifraude para processo de transaçãoboolean
BraspagAntifraudbraspagAntiFraudProviderProvedor de AntifraudeInformar processo de antifraudestring
BraspagAntifraudbraspagFingerPrintOrgIdID da Organização de Impressão DigitalID da organização para impressão digitalstring
BraspagAntifraudbraspagSequenceSequência de análise de fraudeTipo de fluxo de análise de fraudeenum-of-string
BraspagAntifraudbraspagSequenceCriteriaCritérios de análise de fraudeCritérios de fluxo de análise de fraudeenum-of-string
BraspagAntifraudbraspagCaptureOnLowRiskCapturar em caso de Baixo RiscoIndica se a transação será capturada após a análise de fraudeboolean
BraspagAntifraudbraspagVoidOnHighRiskAnular em Caso de Alto RiscoIndica se a transação será capturada após a análise de fraudeboolean
BraspagAntifraudbraspagMerchantDFPBusinessSegmentSegmento de Negócios DFP do ComercianteSegmento de negóciosstring
BraspagAntifraudbraspagMerchantDFPPickupStoreLoja de Retirada DFP do ComercianteIndica se a loja de retirada está habilitada para uso no antifraudeboolean
BraspagAntifraudbraspagProviderMerchantIdProviderMerchantIdIdentificador do comerciante ou operação, fornecido pela Braspagstring

2. Order

GroupIdNameType
BRASPAGbraspagTransactionReceiptRecibo da transaçãotext
BRASPAGbraspagPaymentIdID do pagamentostring
BRASPAGbraspagPaymentMethodTypeTipo do método do pagamentoenum-of-string
BRASPAGbraspagFinalAmountValor finaldouble

3. OrderPaymentInstrument

GroupIdNameDescriptionType
BRASPAGbraspagBoletoDigitableLineBoleto - Linha DigitávelLinha digitável do boletostring
BRASPAGbraspagBoletoExpirationDateBoleto - Data de VencimentoData de vencimento do boletostring
BRASPAGbraspagBoletoUrlBoleto - URLURL do boletostring
BRASPAGcustomerDocNumber Número do Documento do ClienteNúmero do documento do cliente (CPF, CNPJ)string
BRASPAGcustomerDocTypeTipo de Documento do ClienteTipo de documento do cliente (CPF, CNPJ)string
BRASPAGbraspagPixQrCodeBase64ImagePix - Imagem do Código QR em Base64Imagem do código QR em base64text
BRASPAGbraspagPixQrCodeStringPix - String do Código QRString do código QRstring

4. OrderAddress

GroupIdNameType
BRASPAGcomplementComplementstring
BRASPAGdistrictDistrictstring
BRASPAGnumberNumberstring

5. CustomerAddress

GroupIdNameType
BRASPAGcomplementComplementstring
BRASPAGdistrictDistrictstring
BRASPAGnumberNumberstring

6. PaymentCard

GroupIdNameType
BRASPAGbraspagMaxQtyInstallmentsNúmero Máximo de Parcelas Permitidasint