SDK Guide
End‑to‑end guide to integrate the Sublyzer SDK. Covers installer, SDK Customizer, NPM packages, event collection, and best practices.
Quick overview
Sublyzer captures errors, performance, sessions, and security signals from your app. You need a 24-character integration code from the dashboard, then one of the install paths below.
Installer vs manual
- Installer (.exe) — easiest on Windows: download, paste code, pick folder + framework — files are written for you.
- Manual — script tag CDN, or download from SDK Customizer and self-host
sublyzer.js
Installation options
You need your 24-character integration code from the dashboard (Integrations → your app). No secret API keys in the browser — just that code.
The SDK is not on npm. Install via the Windows wizard, a script tag, or download from the SDK Customizer.
A — Windows installer (.exe)
Easiest on Windows: paste your code, pick project folder + framework. Files are written for you.
- Download sublyzer-installer.exe
- Enter integration code → select project path → choose stack
- Click Install → run your app → see events in the dashboard (~60s)
B — Manual install
You place the files yourself — no npm package.
- CDN: one
<script>tag tohttps://www.sublyzer.com/sublyzer.js - Self-host: download from SDK Customizer, put
sublyzer.jsinpublic/sdks/ - Other languages: same Customizer → generated Python, PHP, Go, etc.
Manual — script tag (CDN)
<script src="https://www.sublyzer.com/sublyzer.js" data-integration-code="YOUR_24_CHAR_CODE" defer ></script>
Local dev: add data-api-url="http://localhost:3001"
Manual — download + self-host (Next.js / React)
1. Open SDK Customizer → paste code → Download (sublyzer.js + sublyzer.config.js)
2. Save to public/sdks/sublyzer.js
3. Add the script tag in your layout or HTML:
<script src="/sdks/sublyzer.js" data-integration-code="YOUR_24_CHAR_CODE" defer ></script>
Installer — what it does
The .exe downloads the same canonical sublyzer.js and writes it into your project (e.g. public/sdks/sublyzer.js) plus config snippets for your framework. Same files as the Customizer download.
Deep Scan (PRO) and Strike API are server-side — they do not ship inside the SDK. Full install guide (PT): repo docs/SDK-INSTALL.md.
Self-hosted script (after download)
If you downloaded sublyzer.js from the Customizer or installer, place it under public/sdks/sublyzer.js (Next.js) or your static assets folder:
<script src="/sdks/sublyzer.js" data-integration-code="YOUR_24_CHAR_CODE" defer ></script>
Or load from production CDN: https://www.sublyzer.com/sublyzer.js
Verify data is flowing
After install:
- Open your site and trigger a few page views
- Check the integration dashboard — events appear within seconds
- Use
Sublyzer.flush()on page hide if you batch heavily
Best practices
- Never put API secrets in browser SDKs — only the public integration code.
- Avoid PII in custom events; use opaque user IDs with
identify(). - For server apps, prefer generated Node/Python/PHP SDKs from the Customizer or installer.
Need help? Join our Discord.