Documentation API Sharokey

🚀 Partage de secrets Zero Knowledge

Bienvenue dans la documentation développeur complète de Sharokey, la plateforme de partage sécurisé de secrets avec chiffrement Zero Knowledge.

🔐 Sécurité avant tout

Tous les secrets sont chiffrés côté client avec AES-GCM-256 + PBKDF2 (10 000 itérations) avant d'être envoyés sur nos serveurs. Nous ne voyons jamais vos données en clair.

📚 Que trouverez-vous ici ?

🔌 Comparaison des Fonctionnalités

Comparaison complète des 4 librairies pour choisir la bonne solution.

Voir les Fonctionnalités →

📦 Librairies

4 librairies officielles : CLI C#, JavaScript SDK, JavaScript CDN et Python SDK.

Parcourir les Librairies →

💡 CLI C# Documentation

Outil en ligne de commande cross-platform pour automatisation et scripts.

Guide CLI →

📫 SDK Python

SDK Python async moderne avec nommage cohérent au CLI.

Guide Python →

⚡ Démarrage rapide

Choisissez votre méthode préférée pour commencer avec Sharokey :

CLI C#

# Télécharger le CLI
curl -O https://github.com/sharokey/cli/releases/latest/download/sharokey.exe

# Configurer votre token
sharokey config --token VOTRE_TOKEN_API

# Créer votre premier secret
sharokey create "Mon mot de passe secret" --hours 24 --views 1

JavaScript SDK

// Installer via npm
npm install sharokey-client

// Usage dans Node.js/applications modernes
import { SharokeyClient } from 'sharokey-client';
const client = new SharokeyClient({ token: 'VOTRE_TOKEN_API' });
const secret = await client.createSecret('Mon secret', {hours: 24, views: 1});
console.log(secret.share_url);

JavaScript CDN

<!-- Inclure le script -->
<script src="https://cdn.sharokey.com/js/sharokey.js"></script>

<script>
  // Configuration et utilisation
  Sharokey.config({ token: 'VOTRE_TOKEN_API' });
  const secret = await Sharokey.create('Mon secret', 24, 1);
  console.log(secret.share_url);
</script>

Python

# Installer le SDK
pip install sharokey

# Utilisation de base
import sharokey

client = sharokey.SharokeyClient(token='VOTRE_TOKEN_API')
secret = await client.create('Mon secret', 24, 1)
print(secret.share_url)

cURL

# Appel API direct
curl -X POST https://api.sharokey.com/api/v1/secrets \
  -H "Authorization: Bearer VOTRE_TOKEN_API" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "données_secrètes_chiffrées",
    "keyA": "clé_serveur",
    "hours": 24,
    "maximum_views": 1
  }'

🔐 Architecture Zero Knowledge

Comment ça fonctionne :

1. Vos données ne quittent jamais votre appareil en clair
2. Le chiffrement s'effectue dans votre navigateur/application
3. Système à deux clés : CléA (stockée sur le serveur) + CléB (dans l'URL de partage)
4. Les deux clés sont nécessaires pour déchiffrer le secret
5. Nous ne pouvons pas déchiffrer vos données - véritable Zero Knowledge

🌟 Fonctionnalités

Fonctionnalité	Description
🔐 Zero Knowledge	Chiffrement côté client, nous ne voyons jamais vos secrets
📎 Pièces Jointes	Téléchargez des fichiers jusqu'à 10MB avec vos secrets
📱 Protection OTP	Vérification email et SMS pour une sécurité supplémentaire
⏰ Contrôle d'Expiration	Limites de temps et de vues pour nettoyage automatique
🌍 Multi-domaines	Domaines personnalisés pour partage de secrets avec votre marque
📊 Analyses d'Usage	Suivez la création et l'accès aux secrets
🔌 API REST	Accès programmatique complet
📚 4 Librairies	CLI, JavaScript, Python - choisissez votre stack

🚦 Obtenir votre Token API

1. Inscrivez-vous sur sharokey.com
2. Allez dans Paramètres → Tokens API
3. Créez un nouveau token avec les permissions appropriées
4. Copiez votre token et gardez-le en sécurité

🔑 Sécurité des Tokens

Ne commitez jamais vos tokens API dans le contrôle de version ou ne les exposez pas dans du code côté client. Stockez-les comme variables d'environnement ou dans des fichiers de configuration sécurisés.

📖 Sections de Documentation

🔌 Référence API

Documentation complète de l'API REST couvrant tous les endpoints, méthodes d'authentification, formats de requête/réponse et codes d'erreur.

📦 Librairies Clientes

Librairies officielles pour différents langages de programmation avec guides d'installation, exemples et comparaisons de fonctionnalités.

💡 Exemples de Code

Tutoriels pratiques et exemples de code intégrés dans la documentation des librairies.

📫 Collection Postman

Workspace Postman pré-configuré disponible dans la documentation API.

🤝 Support & Communauté

• 📧 Email : [email protected]
• 🐛 Rapports de Bugs : GitHub Issues
• 💬 Discord : Rejoindre notre communauté
• 📖 Blog : Articles techniques

📜 Licence

Cette documentation est publiée sous Licence MIT.
L'API Sharokey est un service commercial avec une offre gratuite disponible.

---

Commencer avec l'API →Choisir votre Librairie →