Installation
Installez le package @converlay/sdk pour ajouter le suivi d'événements côté serveur à tout storefront headless — Hydrogen, Next.js, Remix, Nuxt ou HTML simple.
Installer le package
npm
npm install @converlay/sdkpnpm
pnpm add @converlay/sdkyarn
yarn add @converlay/sdkDétails du package
Zéro dépendance, ~2 Ko gzippé. Livré en double build ESM + CJS ciblant ES2020.
Options de configuration
| Option | Type | Par défaut | Description |
|---|---|---|---|
shopDomain | string | — | Requis. Votre domaine .myshopify.com |
endpoint | string | https://converlay.app/api/events/collect | Point de collecte de l'API |
autoPageView | boolean | false | Envoyer automatiquement un page_view à l'initialisation |
debug | boolean | false | Afficher les événements dans la console du navigateur |
consent | ConsentInput | {analytics: true, marketing: true} | État initial du consentement |
Points d'entrée
| Import | Contenu |
|---|---|
@converlay/sdk | Fonction factory createConverlay |
@converlay/sdk/react | ConverlayProvider + hook useConverlay (peer dep : react >= 18) |