Authentification

Apprenez comment vous authentifier avec l'API Sharokey en utilisant nos SDK officiels.

🔑 Aperçu

Toutes les opérations de l'API Sharokey nécessitent une authentification en utilisant des tokens API. Nos SDK gèrent toute l'authentification automatiquement une fois configurés.

SDK Officiels :

• Outil CLI C# - Interface en ligne de commande multiplateforme
• JavaScript SDK - Pour Node.js et les applications web modernes
• JavaScript CDN - Intégration navigateur simple
• Python SDK - Client Python asynchrone

🚀 Obtenir Votre Token

1. Inscrivez-vous pour un compte Sharokey sur sharokey.com
2. Accédez à votre tableau de bord → Paramètres → Tokens API
3. Créez un nouveau token avec les portées appropriées
4. Copiez votre token et configurez-le dans votre SDK

⚙️ Configuration du Token

Configurez votre token API en utilisant la méthode appropriée pour votre client :

CLI C#

sharokey config --token YOUR_API_TOKEN

JavaScript SDK

const client = new SharokeyClient({
  token: 'YOUR_API_TOKEN'
});

JavaScript CDN

Sharokey.config({
  token: 'YOUR_API_TOKEN'
});

Python SDK

client = sharokey.SharokeyClient(token='YOUR_API_TOKEN')

🔐 Variables d'Environnement

Pour la sécurité, utilisez des variables d'environnement au lieu de coder les tokens en dur :

CLI C#

export SHAROKEY_TOKEN="YOUR_API_TOKEN"
sharokey config --token $SHAROKEY_TOKEN

JavaScript SDK

const client = new SharokeyClient({
  token: process.env.SHAROKEY_TOKEN
});

JavaScript CDN

// Non recommandé pour l'utilisation côté client
// Utilisez plutôt un proxy côté serveur

Python SDK

import os
client = sharokey.SharokeyClient(token=os.environ['SHAROKEY_TOKEN'])

🛡️ Meilleures Pratiques de Sécurité

Stockage des Tokens

Ne Jamais Exposer les Tokens

• Ne commitez pas les tokens dans le contrôle de version
• Ne loggez pas les tokens dans les journaux d'application
• N'exposez pas les tokens dans le code côté client
• Ne partagez pas les tokens via des canaux non sécurisés

Fonctionnalités de Sécurité SDK

• Chiffrement automatique : Le CLI chiffre et stocke les tokens en sécurité
• Support d'environnement : Tous les SDK supportent les variables d'environnement
• Validation des tokens : Validation automatique avant les appels API
• Gestion d'erreurs : Réponses d'erreur d'authentification structurées

🚨 Erreurs d'Authentification

Tous les SDK gèrent les erreurs d'authentification automatiquement et fournissent des objets d'erreur structurés.

Token Invalide

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Token invalide ou expiré"
  }
}

Token Manquant

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Token API requis"
  }
}

Permissions Insuffisantes

{
  "success": false,
  "error": {
    "code": "PERMISSION_DENIED",
    "message": "Permissions insuffisantes pour cette opération"
  }
}

🔧 Fonctionnalités d'Authentification SDK

Gestion Automatique

• Gestion des tokens : Les SDK stockent et gèrent les tokens en sécurité
• Authentification des requêtes : Inclusion automatique des headers d'auth
• Détection d'erreurs : Feedback immédiat sur les problèmes d'authentification
• Validation des tokens : Validation pré-requête pour éviter les appels échoués

Options de Configuration

• Variables d'environnement : SHAROKEY_TOKEN
• Fichiers de configuration : Stockage chiffré sécurisé (CLI)
• Paramètres de constructeur : Passage direct du token
• Configuration runtime : Mise à jour dynamique des tokens

✅ Vérification

Testez votre configuration d'authentification :

CLI C#

sharokey test-auth

JavaScript SDK

const isValid = await client.testAuthentication();
console.log(isValid ? 'Auth OK' : 'Auth Failed');

JavaScript CDN

const isValid = await Sharokey.testAuth();
console.log(isValid ? 'Auth OK' : 'Auth Failed');

Python SDK

is_valid = await client.test_authentication()
print("Auth OK" if is_valid else "Auth Failed")

🔗 Étapes Suivantes

• Documentation CLI - Configuration de l'interface en ligne de commande
• JavaScript SDK - Intégration JavaScript/Node.js
• Python SDK - Intégration Python
• API Secrets - Créer et gérer des secrets
• Gestion d'Erreurs - Référence complète des erreurs