Skip to content

Clés API

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

Tableau de bord des clés API

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

  1. Allez dans Clés API dans la barre latérale
  2. Cliquez sur Créer une clé API
  3. Entrez un nom descriptif
  4. Basculez Actif (par défaut : activé)
  5. 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 :

bash
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êteValeur
X-API-KeyVotre clé API

Exemple de requête

bash
# 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é

  1. Cliquez sur l'icône modifier
  2. Mettez à jour le nom
  3. Basculez le statut actif
  4. Enregistrez les modifications

Désactiver une clé

Désactiver temporairement une clé :

  1. Cliquez sur Désactiver sur la clé
  2. Confirmez l'action
  3. La clé cesse immédiatement de fonctionner

Activer une clé

Réactiver une clé désactivée :

  1. Cliquez sur Activer sur la clé
  2. Confirmez l'action
  3. La clé fonctionne à nouveau immédiatement

Régénérer une clé

Créer une nouvelle valeur de clé :

  1. Cliquez sur Régénérer
  2. Confirmez l'action (l'ancienne clé cesse de fonctionner)
  3. 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é :

  1. Cliquez sur Supprimer
  2. Confirmez l'action
  3. La clé est définitivement supprimée

Format des clés API

Les clés suivent ce format :

vsk_[environnement]_[chaine-aleatoire]
PréfixeEnvironnement
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 :

LimiteValeur
Par minute60 requêtes
Par heure1 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: 1609459200

Limite 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 :

  1. Vérifiez que la clé est correcte
  2. Vérifiez que la clé est active
  3. 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 :

  1. Vérifiez les fonctionnalités du forfait
  2. Vérifiez la propriété de la clé
  3. Contactez le support

Clé non visible

Si vous avez perdu votre clé :

  1. L'originale ne peut pas être récupérée
  2. Régénérez pour en obtenir une nouvelle
  3. Mettez à jour toutes les intégrations

Limites de clés

Par forfait

ForfaitClés API max
Professionnel5 clés
EntrepriseIllimité

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

Plateforme Professionnelle de Documentation Photo