Client SDK Embed
The BotShield Client SDK is a lightweight web component (<botshield-verify>) that merchants embed directly on their pages to gate checkout, cart, and other sensitive flows behind human presence verification.
CDN: https://cdn.botshield.ai/sdk.js (~9KB minified)
The Client SDK requires a site key (
pk_live_...), which you create in the BotShield Partner Dashboard under Settings > Site Keys.Two Integration Modes
Web Component
Active human verification via BotShield passkey flow. User clicks the widget, completes a passkey challenge, and receives a signed verification token.
Signal Pixel
Passive signal collection. Enable
signals="true" on the web component to run edge scoring and behavioral fingerprinting silently. Low-risk traffic passes automatically; high-risk is escalated.How It Works
Web Component Flow
Signal Pixel Flow
Quick Start
When to Use Which Mode
| Scenario | Recommended Mode | Why |
|---|---|---|
| Checkout protection (Shopify, WooCommerce) | Web Component | Passkey verification = highest assurance |
| Cart page gating | Signal Pixel | Passive, no user friction for low-risk traffic |
| High-value drops / limited releases | Web Component | Every buyer must prove human presence |
| General bot screening | Signal Pixel | Automated scoring filters most bots silently |
| API-driven integrations | Server SDK | Backend-to-backend, no UI component |
Site Keys
Site keys are public/secret key pairs created in the Partner Dashboard:| Key | Prefix | Where Used | Can Do |
|---|---|---|---|
| Public / Site Key | pk_live_ | Frontend data-site-key | Identify merchant, safe to expose |
| Secret Key | sk_live_ | Backend / server only | Verify tokens, call management API |
pk_test_/sk_test_for sandbox environmentspk_live_/sk_live_for production- Public keys are domain-locked at creation (stolen keys are unusable on other domains)
Next Steps
Web Component Reference
Full attribute API, events, states, and integration examples
Signal Pixel Reference
Bot scoring details, signal collection, and configuration
Try in Playground
Test both modes live in the Partner Dashboard playground
Source Code
View the SDK source on GitHub