Configuração

Preferências de Site Personalizadas

Após a importação de metadados, vá a BM > Merchant Tools > Site Preferences > Custom Preferences.

Screenshot — Custom Preferences menu

Selecione Kleep:

Screenshot — Kleep preferences group

Preferência	Descrição
`kleepRetailerUUID`	Obrigatório. Identificador único do seu retalhista na plataforma Kleep, fornecido pelo seu Account Manager Kleep. Deve ser introduzido manualmente — é enviado em cada chamada à API Kleep e utilizado como parâmetro `domain` do iframe de Recomendação para resolver a sua conta. Sem fallback automático: se deixado vazio, o tracking, a funcionalidade de Recomendação e o iframe não funcionarão (é gerado um erro de configuração).
`isKleepRecommendationEnabled`	Ativar/desativar o botão Kleep no PDP. Não afeta o tracking nem as exportações de jobs.
`kleepButtonColor`	Cor do botão (Preto ou Branco). Substitua via CSS para estilização personalizada.
`kleepFontFamily`	Família tipográfica para o botão Kleep e o iFrame.
`kleepCountryCode`	Mercado / Código de País (ISO 3166 A-2).

Serviços

Encontrado em Administration > Operations > Services:

Screenshot — Services list

kleep.sftp — Envia ficheiros de exportação do WebDAV SFCC para o SFTP Kleep. Substitua o utilizador pelo fornecido pelo Kleep, juntamente com o certificado .p12. Não defina qualquer palavra-passe.

Screenshot — kleep.sftp service details

kleep — Utilizado para todas as outras funcionalidades. Não é necessário utilizador/palavra-passe — o pedido é autenticado pela preferência de site kleepRetailerUUID, enviada no payload de cada chamada à API Kleep para resolver a sua conta.

Chave Privada e Certificado

Vá a Administration > Operations > Private Keys and Certificates:

Clique em Import
Clique em Select e escolha o ficheiro .p12 fornecido pelo Kleep
Utilize kleep como alias
Clique em Save

Screenshot — Import certificate

O resultado deve ter este aspeto — deve ser válido e ter o nome kleep:

Screenshot — Imported certificate

Jobs de Exportação

Vá a Administration > Operations > Jobs. Dois jobs estão pré-configurados:

KleepExportProductsCSV — exporta os produtos do seu site
KleepExportOrdersCSV — exporta o histórico de encomendas dos seus clientes

Screenshot — Export jobs list

Ambos estão desativados por padrão. Ative-os para que sejam executados uma vez por dia:

Screenshot — Enabling an export job

Definições comuns (ambos os jobs)

Vá ao separador Job Steps → clique em RefArch para selecionar os sites onde utiliza o Kleep.

Timeout — segundos antes de parar a exportação
OrdersMaxToExport — máximo de encomendas a exportar (apenas no job de encomendas)

Screenshot — GenerateOrdersCSV step parameters

Definições do KleepExportProductsCSV

Screenshot — KleepExportProductsCSV job steps

Parâmetro	Descrição	Padrão
`SkipMaster`	Ignorar exportações de produtos master	Desativado
`OnlineOnly`	Exportar apenas produtos online	Desativado
`ExportType`	Delta (apenas atualizados desde a última exportação) ou Full	Delta
`MainViewType`	Tipo de vista de imagem para imagens de produto. Utilize o mesmo que o seu PDP.	`large`
`Locale`	Locale específico para exportação. Utiliza o padrão se vazio.	—

O número de produtos exportados pode exceder o número processado. Isto acontece quando produtos não categorizados são incluídos através da sua associação com um VariationGroup categorizado.

Certifique-se de que o parâmetro MainViewType corresponde à configuração da sua loja. Um tipo de vista incorreto resulta em imagens de produto em falta, que são necessárias para a análise de IA.

Screenshot — SFTPUpload step parameters (products)

The TargetFolder parameter of each SFTP upload step must match the folder structure expected by Kleep’s ingestion pipeline. For example, a dev store might use dev/products instead of products. See the SFTP Data Structure documentation for the complete directory layout.

KleepResetLastExported (job utilitário)

Um terceiro job, KleepResetLastExported, é fornecido para forçar uma re-exportação completa de encomendas. O seu passo ResetKleepExportAttributes limpa os atributos de tracking de exportação em todas as encomendas (kleepLastExported → vazio, isKleepExported → false) para que sejam recolhidas na próxima execução de KleepExportOrdersCSV. Está desativado por padrão e destina-se a ser executado manualmente, a pedido (por exemplo, após um reset de dados do lado do Kleep). Não recebe parâmetros.

Verificações de Stock em Tempo Real

O Kleep consulta o stock em tempo real para evitar recomendar tamanhos esgotados. Configure o acesso utilizando um dos dois métodos abaixo.

Não sabe qual escolher? OCAPI é a abordagem tradicional usando a API de Dados do Business Manager. SCAPI (IAS) é a nova Salesforce Commerce API com o Inventory Availability Service. Consulte o seu administrador Salesforce em caso de dúvida.

OCAPI (Open Commerce API)
SCAPI — Inventory Availability Service (IAS)

Utilize este método se a sua instância se baseia em OCAPI para gestão de inventário.Passo 1 — Abrir as Definições OCAPINavegue até Administration > Site Development > Open Commerce API Settings e edite as definições da API Data.Passo 2 — Configurar o Client IDPara testes:

"client_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Para produção, gere um novo client ID conforme a documentação Salesforce. Demonstração em vídeo.Passo 3 — Configurar o Acesso a RecursosAdicione isto às suas configurações da API Data OCAPI:

Authorizations
(GET) /inventory_lists/*
(GET) /inventory_lists/*/product_inventory_records/*

Passo 4 — Enviar credenciais ao Kleep

Client ID
Client Secret
IDs de Inventário (um por mercado — forneça o seu mapeamento)
URL SBX de Produção (as verificações de stock estão ativas apenas em produção)

Utilize este método se a sua instância usa SCAPI com o Inventory Availability Service (IAS) / Omnichannel Inventory (OCI).Passo 1 — Criar um Client de API

Inicie sessão no Salesforce Account Manager.
Clique em API Client → Add API Client.
Nome de apresentação: por exemplo Kleep Inventory.
Token Endpoint Auth Method: client_secret_post.
Access Token Format: JWT.
Allowed Scopes: sfcc.inventory.availability
Atribua à sua Organização.
Guarde. Copie o Client ID e o Client Secret — o secret é mostrado apenas uma vez.

Os clients SCAPI e OCAPI não podem ser partilhados. Cada framework de API requer o seu próprio client.

Passo 2 — Recolher identificadores da instância

Identificador	Onde encontrar	Exemplo
Short Code	BM > Administration > Site Development > Salesforce Commerce API Settings	`kv7kzm78`
Organization ID	Mesma página, ou Account Manager	`f_ecom_zzzz_prd`
Tenant ID	Account Manager > Organizations	`zzzz_prd`
Location Group(s)	BM > Merchant Tools > Inventory > Inventory Availability	`WAREHOUSE_FR`, `WAREHOUSE_US`

Passo 3 — Enviar credenciais ao Kleep

Client ID & Client Secret
Short Code
Organization ID
Tenant ID
Location Group(s) (um por mercado — forneça o seu mapeamento)

Bem-vindo

CMS

Mobile

Dados

Privacidade

Preferências de Site Personalizadas

Serviços

Chave Privada e Certificado