Each customer of Spindl needs their own SDK Key to use the SDK. If you don't already have an SDK key, you can generate one on the page in the Spindl app.
Installation via NPM/Yarn
The Spindl SDK is a lightweight npm package. You can install it below. Also here is the npm
*Unsure of whether to use `Default` or Lite? The vast majority of clients use default but feel free to read more about the differences .
Initialization via library
The Spindl SDK only needs to be configured once in a browser or Node session.
If you're using Next.js, in page router, you can do this in pages/_app.tsx
If using app router, you need to implement it in a client side component
For example on how to implement in either one, checkout our
import spindl from "@spindl-xyz/attribution";
spindl.configure({
sdkKey: "<your SDK API key here>",
debugMode: true/false, // we recommend only to have debugMode=true when testing.
// you will see console.logs of emitted events in browser
});
import spindl from "@spindl-xyz/attribution-lite";
spindl.configure({
sdkKey: "<your SDK API key here>",
debugMode: true/false, // we recommend only to have debugMode=true when testing.
// you will see console.logs of emitted events in browser
});
window.spindl.configure({
sdkKey: "<your SDK API key here>",
debugMode: true/false, // we recommend only to have debugMode=true when testing.
// you will see console.logs of emitted events in browser
});
Installation via Script/CDN
Add async script tag at the top of html file within head tag. Please make sure you to use your sdk key.