Skip to content

Référence API

Bienvenue dans la documentation de l'API Sharokey. Sharokey fournit un partage sécurisé de secrets avec chiffrement Zero Knowledge à travers nos SDK officiels.

🚀 Démarrage Rapide

Au lieu d'utiliser l'API brute directement, nous recommandons fortement d'utiliser nos librairies clientes officielles pour la meilleure expérience développeur :

SDK Officiels :

  • CLI C# - Interface en ligne de commande multiplateforme pour l'automatisation et les scripts
  • JavaScript SDK - Librairie complète pour Node.js et les applications web modernes
  • JavaScript CDN - Intégration navigateur simple sans outils de build
  • Python SDK - Client Python asynchrone avec API cohérente CLI

🔐 Sécurité Zero Knowledge

Tous nos SDK implémentent le chiffrement côté client automatiquement :

  • Chiffrement AES-256-GCM avec dérivation de clé PBKDF2
  • Génération automatique de clés et division sécurisée
  • Aucune transmission en clair - le serveur ne voit jamais vos secrets
  • API simple - complexité cachée derrière des méthodes faciles à utiliser

📖 Documentation API

Notre documentation API se concentre sur les structures de données et réponses que vous recevrez en utilisant les SDK :

SectionDescription
AuthentificationConfiguration des tokens et configuration
SecretsCréation, récupération et gestion des secrets
Demandes de SecretDemander des secrets à des tiers de manière sécurisée
Pièces JointesTéléchargement et chiffrement de fichiers
StatistiquesAnalytics d'utilisation d'entreprise
Gestion d'ErreursCodes d'erreur et dépannage
Limites de TauxLimites d'utilisation API et meilleures pratiques

⚡ Avantages des SDK

Pourquoi Utiliser Nos SDK ?

🔒 Sécurité Gérée Automatiquement :

  • Chiffrement côté client avant transmission
  • Génération et gestion sécurisées des clés
  • Génération IV/salt par secret
  • Aucune implémentation crypto requise

🛠️ Expérience Développeur :

  • APIs simples et intuitives
  • Gestion automatique des erreurs
  • Logique de nouvelle tentative intégrée
  • Documentation complète

📦 Tout Inclus :

  • Gestion de l'authentification
  • Gestion des pièces jointes de fichiers
  • Suivi de progression pour les téléchargements
  • Compatibilité multiplateforme

🌟 Choisissez Votre SDK

CLI C# - Ligne de Commande

Parfait pour l'automatisation, les pipelines CI/CD et l'administration système.

bash
sharokey create "Mot de passe base de données" --hours 24 --views 1

JavaScript SDK - Complet

Idéal pour les backends Node.js et les applications web modernes.

javascript
const secret = await client.createSecret("Mot de passe base de données", {
  hours: 24, views: 1
});

JavaScript CDN - Intégration Simple

Intégration navigateur rapide sans outils de build.

javascript
const secret = await Sharokey.create("Mot de passe base de données", 24, 1);

Python SDK - Prêt Async

Client Python asynchrone moderne pour les applications serveur.

python
secret = await client.create("Mot de passe base de données", hours=24, views=1)

🔑 Authentification

Tous les SDK gèrent l'authentification automatiquement une fois configurés. Voir notre Guide d'Authentification pour les instructions de configuration.

🔗 Étapes Suivantes

  1. Choisissez une Librairie - Sélectionnez le SDK qui correspond à votre stack
  2. Configurez l'Authentification - Configurez votre token API
  3. Commencez à Développer - Suivez le démarrage rapide pour votre SDK choisi

Pour les détails de l'API brute, voir les sections de documentation API individuelles ci-dessus. Cependant, nous recommandons d'utiliser nos SDK pour la meilleure expérience.

Released under the MIT License.