> ## 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 el script de seguimiento de clics para atribuir visitas y ventas a sus afiliados.

# Script de Seguimiento de Afiliados

El script `clicks.js` de caBRAPI rastrea clics y visitas de los afiliados en su tienda. Cuando un visitante accede con `?ref=` en la URL, el script registra el clic y guarda el código del afiliado en una cookie para atribución futura.

## Cómo funciona

1. El afiliado comparte un enlace como `https://sualoja.com/?ref=CODIGO`
2. El visitante accede al enlace
3. El script detecta el `?ref=`, guarda la cookie `affiliate_id` y envía el clic a la API
4. Aunque el visitante navegue a otras páginas sin el `?ref=`, la cookie continúa atribuyendo visitas al afiliado
5. Si el visitante realiza una compra, el checkout envía el código del afiliado para comisión

## Instalación

Agregue el script **antes del `</body>`** en su 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 | Obligatorio | Descripción | Por defecto |
| - | - | - | - |
| `data-store` | Sí | ID de su tienda en caBRAPI | — |
| `data-api` | No | URL de la API de caBRAPI | `https://api.cabrapi.com.br` |
| `data-days` | No | Días de vida de la cookie | `30` |

## Ejemplo completo

```html theme={null}
<!DOCTYPE html>
<html lang="es">
<head>
  <meta charset="UTF-8" />
  <title>Mi Tienda</title>
</head>
<body>
  <h1>Bienvenido a mi tienda</h1>

  <!-- Tu contenido -->

  <!-- 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 enlace aceptados

El script detecta al afiliado por cualquiera de estos formatos:

| Formato | Ejemplo |
| - | - |
| 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` |

El código del afiliado debe tener entre 2 y 64 caracteres (letras, números, `_` o `-`).

## Cookie

* **Nombre:** `affiliate_id`
* **Duración:** 30 días (o el valor definido en `data-days`)
* **Propiedad:** `SameSite=Lax`, `path=/`
* La cookie se actualiza siempre que se detecta un nuevo `?ref=`

## Checkout (atribución de compra)

Para que el checkout atribuya la compra al afiliado, lea la cookie `affiliate_id` en el momento del pago:

```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.