> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cabrapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Script de Afiliados

> Instale o script de rastreamento de cliques para atribuir visitas e vendas aos seus afiliados.

# Script de Rastreamento de Afiliados

O script `clicks.js` da caBRAPI rastreia cliques e visitas dos afiliados na sua loja. Quando um visitante acessa com `?ref=` na URL, o script registra o clique e salva o código do afiliado em um cookie para atribuição futura.

## Como funciona

1. O afiliado compartilha um link como `https://sualoja.com/?ref=CODIGO`
2. O visitante acessa o link
3. O script detecta o `?ref=`, salva o cookie `affiliate_id` e envia o clique para a API
4. Mesmo que o visitante navegue para outras páginas sem o `?ref=`, o cookie continua atribuindo visitas ao afiliado
5. Se o visitante fizer uma compra, o checkout envia o código do afiliado para comissão

## Instalação

Adicione o script **antes do `</body>`** na sua página HTML:

```html theme={null}
<script
  src="https://www.cabrapi.com.br/script/clicks.js"
  data-store="ID_DA_LOJA"
  data-api="https://api.cabrapi.com.br"
  data-days="30"
></script>
```

## Parâmetros

| Atributo | Obrigatório | Descrição | Padrão |
| - | - | - | - |
| `data-store` | Sim | ID da sua loja no caBRAPI | — |
| `data-api` | Não | URL da API do caBRAPI | `https://api.cabrapi.com.br` |
| `data-days` | Não | Dias de vida do cookie | `30` |

## Exemplo completo

```html theme={null}
<!DOCTYPE html>
<html lang="pt-BR">
<head>
  <meta charset="UTF-8" />
  <title>Minha Loja</title>
</head>
<body>
  <h1>Bem-vindo à minha loja</h1>

  <!-- Seu conteúdo -->

  <!-- Script de rastreamento de afiliados -->
  <script
    src="https://www.cabrapi.com.br/script/clicks.js"
    data-store="abc123"
    data-api="https://api.cabrapi.com.br"
    data-days="30"
  ></script>
</body>
</html>
```

## Formatos de link aceitos

O script detecta o afiliado por qualquer um desses formatos:

| Formato | Exemplo |
| - | - |
| Query parameter | `?ref=CODIGO` |
| Hash parameter | `#ref=CODIGO` |
| Path prefix `/r/` | `/r/CODIGO` |
| Path prefix `/ref/` | `/ref/CODIGO` |
| Path prefix `/aff/` | `/aff/CODIGO` |
| Path prefix `/afiliado/` | `/afiliado/CODIGO` |

O código do afiliado deve ter entre 2 e 64 caracteres (letras, números, `_` ou `-`).

## Cookie

* **Nome:** `affiliate_id`
* **Duração:** 30 dias (ou o valor definido em `data-days`)
* **Propriedade:** `SameSite=Lax`, `path=/`
* O cookie é atualizado sempre que um novo `?ref=` é detectado

## Checkout (atribuição de compra)

Para que o checkout atribua a compra ao afiliado, leia o cookie `affiliate_id` no momento do pagamento:

```javascript theme={null}
function getAffiliateId() {
  const m = document.cookie.match(/(?:^|; )affiliate_id=([^;]*)/);
  if (!m) return null;
  try {
    return decodeURIComponent(m[1]);
  } catch {
    return m[1];
  }
}

// Enviar no payload de pagamento
const affiliateId = getAffiliateId();
if (affiliateId) {
  // Incluir no campo metadata.affiliate do pagamento
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.