EngageNudge
DocsÖppna dashboardFå hjälp

Docs / Utvecklare

JavaScript SDK

Webbläsar-SDK registrerar service workern, ber om tillstånd enligt era promptinställningar och lagrar push-prenumerationen mot er sajt.

Snippet

Snippeten laddar en-sdk.js från EngageNudge, så SDK-fixar når er sajt utan att ni laddar upp något igen. Dashboard-snippeten ser ut så här:

html
<script
  src="https://engagenudge.com/sdk/v1/en-sdk.js"
  data-site-key="YOUR_SITE_KEY"
  data-vapid="YOUR_VAPID_PUBLIC_KEY"
  data-api="https://api.engagenudge.com"
  data-tenant-id="YOUR_TENANT_ID"
  data-site-id="YOUR_SITE_ID"
  async
></script>

API-hosten är https://api.engagenudge.com.

/en-sw.js hostar ni fortfarande själva. En webbläsare accepterar bara en service worker som serveras från sidans origin, men den är nu en stub som importerar logiken från oss. Se Service worker.

Versioner

URLCacheNär
https://engagenudge.com/sdk/v1/en-sdk.js1 timme, revalideras i bakgrundenStandard. Får varje bakåtkompatibel fix.
https://engagenudge.com/sdk/1.0.0/en-sdk.jsImmutablePinna en exakt build. Ni uppgraderar genom att ändra URL:en.

Kanalen v1 bär bara bakåtkompatibla builds. En brytande ändring skulle ligga på /sdk/v2/.

Flytta från självhostad en-sdk.js

Äldre installationer kopierade en-sdk.js till sin egen webbrot. De fortsätter fungera, men fryser på den build ni laddade upp, och Install Doctor rapporterar sdk_outdated när den halkar efter.

  1. Byt src="/en-sdk.js" mot src="https://engagenudge.com/sdk/v1/en-sdk.js". Inget annat i snippeten ändras.
  2. Byt /en-sw.js mot stubben från Integrationer så att även worker-fixar når er. Att behålla hela filen fungerar också.
  3. Ta bort gamla en-sdk.js ur webbroten när den nya snippeten är live.
  4. Om ni skickar CSP: tillåt https://engagenudge.com i script-src. Se CSP.

Vad SDK gör

  • Läser data-site-key, data-vapid och data-api
  • Registrerar /en-sw.js
  • Visar er konfigurerade opt-in-prompt, sedan native-tillståndsdialogen
  • Skickar prenumerationen till API (tenant-avgränsat)

Lägg inte den privata VAPID-nyckeln på sidan. Bara den publika nyckeln hör hemma i data-vapid.

Beteendehändelser

track() postar till POST /v1/behavior-events. Commerce-automation som konsumerar de händelserna är av som standard. Se Beteendehändelser.

npm

Ett paketerat SDK finns för byggen som föredrar import framför snippet. Snippet-vägen är standard för WordPress, GTM och de flesta sajter.

Relaterat

Nästa

Service worker