prod server running[...]docs.mdDocumentation
Learn how to integrate and use our tools effectively in your workflow.
Getting Started with Cask
Cask provides a secure code delivery system that protects your intellectual property until payment is received, giving developers confidence when sharing their work.
1. Protect
Wrap your code with a secure access control layer that verifies payment status.
2. Monitor
Track code access and manage permissions through the bl0q dashboard.
3. Control
Remotely enable or disable access based on payment status and terms.
How It Works
Cask acts as a protective wrapper around your code, ensuring it's only accessible when payment conditions are met:
For Developers
- Integrate the Cask wrapper into your codebase
- Set payment requirements through the dashboard
- Share your protected code with clients
- Receive notification when payment is made
- Access is automatically granted upon verification
For Clients
- Receive protected code with limited preview functionality
- Make payment through secure payment channels
- Gain immediate full access once payment is verified
- No need for separate software or complex setup
Installation
npm install @bl0q/caskCask is compatible with React, Next.js, and other modern JavaScript frameworks.
Basic Usage
View Examplesimport { CaskWrapper } from '@bl0q/cask';
// In your root component or layout
export default function RootLayout({ children }) {
return (
<CaskWrapper
apiKey="YOUR_DASHBOARD_API_KEY"
enforceSSL={true}
checkInterval={30000}
>
{children}
</CaskWrapper>
);
}Security Best Practices
- • Store API keys in environment variables (process.env.CASK_API_KEY)
- • Always enable SSL enforcement in production
- • Regularly rotate your API keys from the bl0q dashboard
- • Set appropriate access check intervals for your application
API Reference
Wrapper Options
apiKeystringenforceSSLbooleancheckIntervalnumberfallbackUIReactNodeEvent Handlers
onAccessRevokedfunctiononAccessGrantedfunctiononErrorfunctionDashboard Integration
The Cask dashboard gives you complete control over access management:
Access Management
Grant, revoke, or temporarily suspend access with one click.
Usage Analytics
Track active users, subscription status, and payment history.
API Key Management
Your API key connects your application to the Cask access control system. Safeguard it carefully and rotate keys if you suspect they've been compromised.
// Best practice: Use environment variables const apiKey = process.env.CASK_API_KEY; // Never do this: const apiKey = "cask_live_9a8b7c6d5e4f3g2h1i"; // Exposed in client-side code
© 2025bl0q.
Help & Support
founders@bl0q.app
[Trusted Digital Workflow]
SecureFairSeamless