Instalação
Instale o pacote @converlay/sdk para adicionar rastreamento de eventos server-side a qualquer storefront headless — Hydrogen, Next.js, Remix, Nuxt ou HTML puro.
Instale o pacote
npm
npm install @converlay/sdkpnpm
pnpm add @converlay/sdkyarn
yarn add @converlay/sdkDetalhes do pacote
Zero dependências, ~2 KB gzipado. Disponível em build dual ESM + CJS com target ES2020.
Opções de configuração
| Opção | Tipo | Padrão | Descrição |
|---|---|---|---|
shopDomain | string | — | Obrigatório. Seu domínio .myshopify.com |
endpoint | string | https://converlay.app/api/events/collect | Endpoint da API de coleta |
autoPageView | boolean | false | Enviar automaticamente page_view ao inicializar |
debug | boolean | false | Registrar eventos no console do navegador |
consent | ConsentInput | {analytics: true, marketing: true} | Estado de consentimento inicial |
Pontos de entrada
| Importação | Conteúdo |
|---|---|
@converlay/sdk | Função factory createConverlay |
@converlay/sdk/react | ConverlayProvider + hook useConverlay (peer dep: react >= 18) |