Sharokey API Documentation - Zero Knowledge Secret Sharing Platform
🚀 Secure Secret Sharing API with Zero Knowledge Encryption
Welcome to the complete developer documentation for Sharokey, the secure secret sharing platform with Zero Knowledge encryption technology.
🔐 Security First
All secrets are encrypted client-side using AES-GCM-256 + PBKDF2 (10,000 iterations) before being sent to our servers. We never see your data in plain text.
📚 Developer Resources and API Libraries
📦 Client Libraries
4 official libraries: CLI C#, Python SDK, JavaScript SDK, and JavaScript CDN for easy integration.
Browse Libraries →💡 CLI C# Documentation
Cross-platform command-line tool for automation, scripting, and CI/CD integration.
CLI Guide →🚀 Code Examples
See all CLI examples adapted to every library with side-by-side comparison.
Browse Examples →⚡ Quick Start Guide - Getting Started with Sharokey API
Choose your preferred development approach to start using Sharokey secure secret sharing:
# Download the CLI
curl -O https://github.com/sharokey/cli/releases/latest/download/sharokey.exe
# Configure your token
sharokey config --token YOUR_API_TOKEN
# Create your first secret
sharokey create "My secret password" --hours 24 --views 1# Install via pip
pip install sharokey
# Configure and use
from sharokey import SharokeyClient
client = SharokeyClient(token='YOUR_API_TOKEN')
secret = await client.create('My secret', 24, 1)
print(secret.share_url)# Install via NPM
npm install Sharokey/sharokey-js
# Configure and use
import Sharokey from 'sharokey-js';
Sharokey.config({ token: 'YOUR_API_TOKEN' });
const secret = await Sharokey.create('My secret', 24, 1);
console.log(secret.share_url);<!-- Include the script -->
<script src="https://cdn.jsdelivr.net/gh/Sharokey/sharokey-cdn@latest/sharokey.js"></script>
<script>
// Configure and use
Sharokey.config({ token: 'YOUR_API_TOKEN' });
const secret = await Sharokey.create('My secret', 24, 1);
console.log(secret.share_url);
</script>🔐 Zero Knowledge Encryption Architecture - How Sharokey Protects Your Secrets
How it works:
- Your data never leaves your device in plain text
- Encryption happens in your browser/application
- Two-key system: KeyA (stored on server) + KeyB (in share URL)
- Both keys required to decrypt the secret
- We can't decrypt your data - true Zero Knowledge
🌟 Sharokey API Features - Complete Secret Management Solution
| Feature | Description |
|---|---|
| 🔐 Zero Knowledge | Client-side encryption, we never see your secrets |
| 📎 File Attachments | Upload files up to 10MB with your secrets |
| 📱 OTP Protection | Email & SMS verification for extra security |
| ⏰ Expiration Control | Time and view limits for automatic cleanup |
| 🌍 Multi-domain | Custom domains for branded secret sharing |
| 📊 Usage Analytics | Track secret creation and access patterns |
| 🔌 REST API | Complete programmatic access |
| 📚 4 Libraries | CLI, Python SDK, JavaScript SDK, and JavaScript CDN - choose your stack |
🚦 How to Get Your Sharokey API Token - Authentication Setup
- Sign up at sharokey.com
- Go to Settings → API Tokens
- Create a new token with appropriate scopes
- Copy your token and keep it secure
🔑 Token Security
Never commit your API tokens to version control or expose them in client-side code. Store them as environment variables or in secure configuration files.
📖 Complete API Documentation Sections
🔐 Zero Knowledge Security Implementation
All client libraries implement mandatory client-side AES-GCM-256 encryption. The raw REST API cannot be used directly due to our Zero Knowledge architecture - ensuring your secrets remain private.
📦 Official Client Libraries - Multi-Language SDK Support
Choose from our official libraries for different programming languages with installation guides, code examples, and feature comparisons:
- CLI C# Tool: Cross-platform command-line interface for automation and scripting
- Python SDK: Async/await package with comprehensive type hints and error handling
- JavaScript SDK: NPM package with TypeScript support and Node.js/Browser compatibility
- JavaScript CDN Library: Browser-ready library with zero dependencies
🔍 Frequently Asked Questions (FAQ)
What is Zero Knowledge encryption?
Zero Knowledge encryption means your data is encrypted on your device before transmission. Sharokey servers never see your plain text secrets - we only store encrypted data that we cannot decrypt.
Which programming languages are supported?
Currently supported: C# (CLI tool), Python (SDK), and JavaScript (SDK + CDN library). All four libraries provide identical functionality and security features.
Can I use Sharokey for enterprise applications?
Yes, Sharokey supports custom domains, usage analytics, and enterprise-grade security features suitable for business applications.
How secure are my secrets?
Extremely secure. We use AES-GCM-256 encryption with PBKDF2 key derivation (10,000 iterations). Even if our servers were compromised, your data would remain encrypted and unreadable.
🤝 Support & Community
- 📧 Email: [email protected]
- 🐛 Bug Reports: GitHub Issues
- 📖 Blog: Technical articles
📜 License
This documentation is released under the MIT License.
Sharokey API is a commercial service with free tier available.