API - Authentification
L'authentification API NEURASCOPE repose sur des clés API avec un système de scopes pour contrôler les permissions d'accès.
Clés API Format
Les clés API NEURASCOPE suivent le format : nsc_ suivi d'une chaîne alphanumérique unique (ex : nsc_HGLBPpga...).
Obtenir une Clé API
- Connectez-vous à NEURASCOPE
- Allez dans API Keys (sidebar ou dashboard)
- Cliquez sur Créer une clé API
- Donnez un nom descriptif à la clé (ex : "API Production", "API Développement")
- Sélectionnez les scopes nécessaires
- Validez
La clé complète n'est affichée qu'une seule fois lors de la création. Copiez-la et stockez-la en sécurité.
Utiliser la Clé API
Incluez votre clé dans le header Authorization de chaque requête :
Authorization: Bearer nsc_VOTRE_CLE_API Exemple cURL curl -X GET https://app.neurascope.ai/api/v1/projects \ -H "Authorization: Bearer nsc_HGLBPpga..." Exemple JavaScript (fetch) const response = await fetch('https://app.neurascope.ai/api/v1/projects', { headers: { 'Authorization': 'Bearer nsc_VOTRE_CLE_API', 'Content-Type': 'application/json' } }); Exemple Python (requests) import requests
headers = { 'Authorization': 'Bearer nsc_VOTRE_CLE_API', 'Content-Type': 'application/json' } response = requests.get('https://app.neurascope.ai/api/v1/projects', headers=headers) Scopes (Permissions)
Les scopes contrôlent ce qu'une clé API peut faire. Attribuez uniquement les scopes nécessaires pour respecter le principe du moindre privilège.
Scopes Disponibles Scope Description orchestration:read Lire les workflows et crews orchestration:write Créer et exécuter des workflows et crews chat:read Lire les sessions et messages chat:write Créer des sessions et envoyer des messages rag:read Rechercher dans les espaces RAG rag:write Ajouter et gérer les documents RAG projects:read Lire les projets projects:write Créer et modifier les projets personas:read Lire les personas personas:write Créer et modifier les personas users:read Lire la liste des utilisateurs users:write Gérer les utilisateurs stats:read Lire les statistiques api-keys:manage Gérer les clés API Rôles des Clés
Chaque clé API est associée à un rôle qui détermine son niveau d'accès :
Rôle Description Admin Accès complet à tous les scopes Éditeur Lecture et écriture sur les modules IA Lecteur Lecture seule Gérer vos Clés Voir les clés existantes
La page API Keys liste toutes vos clés avec :
- Nom de la clé
- Clé masquée (seuls les premiers caractères sont visibles)
- Rôle assigné
- Scopes activés
- Date de création
- Dernière utilisation
Révoquer une clé
Cliquez sur Supprimer pour révoquer une clé. Cette action est immédiate et irréversible. Toutes les applications utilisant cette clé cesseront de fonctionner.
Sécurité
- Ne partagez jamais vos clés API dans du code source public (GitHub, GitLab…)
- Utilisez des variables d'environnement pour stocker vos clés
- Créez des clés distinctes pour chaque application ou environnement (dev, staging, prod)
- Révoquez immédiatement toute clé compromise
- Appliquez le moindre privilège : n'activez que les scopes nécessaires