Clés API
Authentifiez les requêtes API avec des clés API sécurisées.

Aperçu
Les clés API vous permettent de :
- Authentifier les requêtes API
- Intégrer avec des systèmes externes
- Automatiser les workflows de demande de photos
- Construire des applications personnalisées
Exigence de forfait
L'accès API nécessite un forfait qui inclut les fonctionnalités API.
Créer une clé API
Étapes
- Allez dans Clés API dans la barre latérale
- Cliquez sur Créer une clé API
- Entrez un nom descriptif
- Basculez Actif (par défaut : activé)
- Cliquez sur Créer
Enregistrer votre clé
Affichage unique
La clé API complète est affichée une seule fois à la création. Copiez-la et stockez-la en sécurité. Vous ne pouvez pas la récupérer plus tard.
Après création :
- Copiez la clé immédiatement
- Stockez dans un emplacement sécurisé
- Ne partagez jamais publiquement
Utiliser les clés API
En-tête d'authentification
Incluez la clé API dans les en-têtes de requête :
curl -X GET "https://api.visio.now/v1/status" \
-H "X-API-Key: votre-cle-api-ici"Nom de l'en-tête
| En-tête | Valeur |
|---|---|
X-API-Key | Votre clé API |
Exemple de requête
# Créer une demande de photos
curl -X POST "https://api.visio.now/v1/photo-requests" \
-H "X-API-Key: vsk_live_abc123..." \
-H "Content-Type: application/json" \
-d '{
"instructions": "Veuillez envoyer des photos du véhicule",
"photo_slots": [
{"instructions": "Vue de face", "is_required": true},
{"instructions": "Vue arrière", "is_required": true}
]
}'Gérer les clés API
Voir les clés
La liste des clés API affiche :
- Nom de la clé
- Clé masquée (affichage partiel)
- Statut actif/inactif
- Date de dernière utilisation
- Date de création
Modifier une clé
- Cliquez sur l'icône modifier
- Mettez à jour le nom
- Basculez le statut actif
- Enregistrez les modifications
Désactiver une clé
Désactiver temporairement une clé :
- Cliquez sur Désactiver sur la clé
- Confirmez l'action
- La clé cesse immédiatement de fonctionner
Activer une clé
Réactiver une clé désactivée :
- Cliquez sur Activer sur la clé
- Confirmez l'action
- La clé fonctionne à nouveau immédiatement
Régénérer une clé
Créer une nouvelle valeur de clé :
- Cliquez sur Régénérer
- Confirmez l'action (l'ancienne clé cesse de fonctionner)
- Copiez la nouvelle clé immédiatement
Invalidation immédiate
Régénérer invalide instantanément l'ancienne clé. Mettez à jour toutes les intégrations avant de régénérer.
Supprimer une clé
Supprimer définitivement une clé :
- Cliquez sur Supprimer
- Confirmez l'action
- La clé est définitivement supprimée
Format des clés API
Les clés suivent ce format :
vsk_[environnement]_[chaine-aleatoire]| Préfixe | Environnement |
|---|---|
vsk_live_ | Production |
vsk_test_ | Test |
Bonnes pratiques de sécurité
Stockage des clés
- Stockez dans les variables d'environnement
- Utilisez des systèmes de gestion des secrets
- Ne commitez jamais dans le contrôle de version
- N'incluez pas dans le code côté client
Rotation des clés
- Effectuez une rotation des clés périodiquement
- Effectuez une rotation immédiatement si compromis
- Utilisez des clés à durée de vie courte pour les tests
Contrôle d'accès
- Créez des clés séparées par intégration
- Utilisez des noms descriptifs
- Surveillez l'utilisation des clés
- Désactivez les clés inutilisées
Ce qu'il ne faut PAS faire
- Partager des clés par e-mail
- Poster des clés dans le chat/Slack
- Inclure dans les URLs
- Stocker dans des fichiers en texte brut
Limitation de débit
Les requêtes API sont limitées en débit :
| Limite | Valeur |
|---|---|
| Par minute | 60 requêtes |
| Par heure | 1 000 requêtes |
En-têtes de limite de débit
Les réponses incluent :
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200Limite dépassée
Quand dépassée :
- Réponse HTTP 429
- Réessayez après le temps indiqué
- Implémentez un backoff exponentiel
Dépannage
401 Non autorisé
Causes :
- Clé API invalide
- Clé désactivée
- Clé supprimée/régénérée
- En-tête manquant
Solutions :
- Vérifiez que la clé est correcte
- Vérifiez que la clé est active
- Régénérez si nécessaire
403 Interdit
Causes :
- La clé n'a pas la permission
- Fonctionnalité pas dans le forfait
- Restrictions de l'espace de travail
Solutions :
- Vérifiez les fonctionnalités du forfait
- Vérifiez la propriété de la clé
- Contactez le support
Clé non visible
Si vous avez perdu votre clé :
- L'originale ne peut pas être récupérée
- Régénérez pour en obtenir une nouvelle
- Mettez à jour toutes les intégrations
Limites de clés
Par forfait
| Forfait | Clés API max |
|---|---|
| Professionnel | 5 clés |
| Entreprise | Illimité |
Recommandations
- Production : 1 clé par intégration
- Développement : Clés de test séparées
- CI/CD : Clé de déploiement dédiée
Pages connexes
- Référence API - Documentation API complète
- Webhooks - Notifications en temps réel
- Intégrations - Intégrations pré-construites
