> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kleep.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Configuração
> Preferências de site, serviços, certificados, jobs de exportação e verificações de stock em tempo real
## Preferências de Site Personalizadas
Após a importação de metadados, vá a **BM > Merchant Tools > Site Preferences > Custom Preferences**.
Selecione **Kleep**:
| 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)). |
## Serviços
Encontrado em **Administration > Operations > Services**:
**`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.
**`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**:
1. Clique em **Import**
2. Clique em **Select** e escolha o ficheiro `.p12` fornecido pelo Kleep
3. Utilize `kleep` como alias
4. Clique em **Save**
O resultado deve ter este aspeto — deve ser válido e ter o nome `kleep`:
## 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
Ambos estão **desativados por padrão**. Ative-os para que sejam executados uma vez por dia:
### 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)*
### Definições do KleepExportProductsCSV
| 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.
### 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.
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 OCAPI**
Navegue até **Administration > Site Development > Open Commerce API Settings** e edite as definições da API **Data**.
**Passo 2 — Configurar o Client ID**
Para testes:
```
"client_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
```
Para produção, gere um novo client ID conforme a [documentação Salesforce](https://help.salesforce.com/s/articleView?id=cc.b2c_generate_api_client_id.htm\&type=5). [Demonstração em vídeo](https://www.youtube.com/watch?v=Z3cZlQHWjtM).
**Passo 3 — Configurar o Acesso a Recursos**
Adicione 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**
1. Inicie sessão no [Salesforce Account Manager](https://account.demandware.com).
2. Clique em **API Client** → **Add API Client**.
3. Nome de apresentação: por exemplo `Kleep Inventory`.
4. Token Endpoint Auth Method: `client_secret_post`.
5. Access Token Format: `JWT`.
6. Allowed Scopes: `sfcc.inventory.availability`
7. Atribua à sua Organização.
8. 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)