Gérer vos clés API Wix

Temps de lecture : 10 min
Clés API Wix sont des codes que vous pouvez générer pour autoriser un utilisateur ou une application et lui donner accès aux données de votre site et de votre compte.
Utilisez les clés API Wix pour accéder à des données telles que vos commandes, vos articles et vos événements pour construire vos propres fonctionnalités personnalisées et se connecter avec des services tiers. 

Générer une clé API Wix

Vous pouvez générer une clé API pour accéder aux données de votre site dans les paramètres de votre compte. 
Important
  • Par défaut, chaque clé API que vous générez a accès à tous les sites de votre compte. En effet, les clés API sont générées au niveau du compte. 
  • Pour plus de sécurité, chaque jeton de clé API que vous générez n'est affiché qu'une seule fois lorsque vous le créez. 
  • Il n'est pas possible d'afficher à nouveau le jeton d'une clé API après avoir fermé la fenêtre pop-up Vous avez généré une clé API . Assurez-vous de conserver votre token dans un endroit sûr afin de pouvoir y accéder à l'avenir.

Pour générer une clé API :

  1. Accédez à Clés API dans les paramètres de votre compte.
  2. Cliquez sur Générer une clé API .
  3. Saisissez un nom pour votre nouvelle clé API sous Détails de la clé. 
  4. Sélectionnez les autorisations que vous souhaitez attribuer à la clé API. 
    • L'autorisation de base pour renvoyer les ID de tous les sites sur votre compte est sélectionnée par défaut. Il ne peut pas être désélectionné.
    • Pour des raisons de sécurité, n'ajoutez que les autorisations dont vous avez besoin. En savoir plus
  5. Cliquez sur Générer une clé .
  6. Cliquez sur Envoyer le code pour envoyer un code de vérification à 6 chiffres à l'adresse e-mail liée à votre compte
  7. Obtenez votre code de vérification dans l'e-mail.
  8. Saisissez le code dans la fenêtre pop-up Vérifier votre compte.
  9. Cliquez sur Vérifier et générer la clé.
Une capture d'écran de la vérification d'une clé API
  1. Cliquez sur Copier le jeton et fermer
  2. Conservez le jeton dans un endroit sûr. 
Suggestion :
Si vous avez besoin d'une autre clé API avec les mêmes autorisations, vous pouvez faire pivoter la clé API ou dupliquer la clé API .

Faire pivoter une clé API Wix

Vous pouvez faire pivoter une clé API pour créer un nouveau jeton tout en conservant le même nom, la même description et les mêmes autorisations. Après la rotation d'une clé API, toute personne qui y avait précédemment accès ne pourra plus l'utiliser et vous devrez partager le nouveau jeton avec elle.
Important :
  • Après avoir fait pivoter une clé API, tout utilisateur ou toute appli qui l'a précédemment utilisée perdra immédiatement l'accès à vos données. 
  • Il n'est pas possible de récupérer un token précédent après avoir fait pivoter sa clé API.
Suggestion :
  • Dans la plupart des cas, il est préférable de dupliquer la clé API, ajoutez le nouveau jeton à vos appels API, partagez le nouveau jeton avec tous les membres de l'équipe qui en ont besoin et supprimez l'ancienne clé API. 
  • Cela garantit que les API qui utilisent la clé n'auront pas d'interruption de service. 
  • Nous vous recommandons de ne faire tourner une clé API que si vous pensez que votre clé a été compromise

Pour faire pivoter une clé API :

  1. Accédez à Clés API dans les paramètres de votre compte.
  2. Cliquez sur l'icône Plus d'actions  à côté de la clé API que vous souhaitez faire pivoter.
  3. Sélectionnez Rotation.
Une capture d'écran de la rotation d'une clé API
  1. Cliquez sur Faire pivoter la clé dans la fenêtre pop-up.
  2. Cliquez sur Envoyer le code pour envoyer un code de vérification à 6 chiffres à l'adresse e-mail liée à votre compte
  3. Obtenez votre code de vérification dans l'e-mail.
  4. Saisissez le code dans la fenêtre pop-up Vérifier votre compte.
  5. Cliquez sur Valider et faire pivoter la clé.
Une capture d'écran de la validation d'une clé API en rotation
  1. Cliquez sur Copier le jeton et fermer
  2. Conservez le jeton dans un endroit sûr. 

Dupliquer une clé API Wix

Vous pouvez dupliquer l'une de vos clés API existantes si vous avez besoin d'une autre clé API avec les mêmes autorisations. Après avoir dupliqué une clé, vous pouvez également modifier sa description et ses autorisations si vous avez besoin de la personnaliser davantage.
Important
  • Par défaut, chaque clé API que vous générez a accès à tous les sites de votre compte. En effet, les clés API sont générées au niveau du compte. 
  • Pour plus de sécurité, chaque jeton de clé API que vous générez n'est affiché qu'une seule fois lorsque vous le créez. 
  • Il n'est pas possible d'afficher à nouveau le jeton d'une clé API après avoir fermé la fenêtre pop-up Vous avez généré une clé API . Assurez-vous de conserver votre token dans un endroit sûr afin de pouvoir y accéder à l'avenir.

Pour dupliquer une clé API :

  1. Accédez à Clés API dans les paramètres de votre compte.
  2. Cliquez sur l'icône Plus d'actions  à côté de la clé API que vous souhaitez dupliquer.
  3. Sélectionnez Dupliquer.
Une capture d'écran de la duplication d'une clé API
  1. Saisissez un nouveau nom pour votre nouvelle clé API sous Détails de la clé. 
  2. (Facultatif) Modifiez les autorisations attribuées à la clé API. 
    • L'autorisation de base pour renvoyer les ID de tous les sites sur votre compte est sélectionnée par défaut. Il ne peut pas être désélectionné.
    • Pour des raisons de sécurité, n'ajoutez que les autorisations dont vous avez besoin. En savoir plus
  3. Cliquez sur Générer une clé .
  4. Cliquez sur Envoyer le code pour envoyer un code de vérification à 6 chiffres à l'adresse e-mail liée à votre compte
  5. Obtenez votre code de vérification dans l'e-mail.
  6. Saisissez le code dans la fenêtre pop-up Vérifier votre compte.
  7. Cliquez sur Vérifier et générer la clé.
Une capture d'écran de la vérification d'une clé API dupliquée
  1. Cliquez sur Copier le jeton et fermer.
  2. Conservez la clé dans un endroit sûr. 

Modifier une clé API Wix

Vous pouvez mettre à jour le nom et les autorisations d'une clé API après l'avoir créée sur sa page Modifier la clé API
Important :
Tout membre autorisé de votre équipe peut modifier les clés API de votre compte. Pour modifier les personnes autorisées à modifier vos clés API, accédez à la page Rôles et autorisations ou votre tableau de bord Partenaire si vous êtes un partenaire Wix.

Pour modifier une clé API :

  1. Accédez à Clés API dans les paramètres de votre compte.
  2. Cliquez sur l'icône Plus d'actions  à côté de la clé API que vous souhaitez modifier.
  3. Sélectionnez Modifier.
Une capture d'écran de la modification d'une clé API
  1. Modifiez le nom ou les autorisations de la clé API.
  2. Cliquez sur Enregistrer et fermer.
Une capture d'écran de l'enregistrement des modifications apportées à une clé API
  1. Cliquez sur Envoyer le code pour envoyer un code de vérification à 6 chiffres à l'adresse e-mail liée à votre compte
  2. Obtenez votre code de vérification dans l'e-mail.
  3. Saisissez le code dans la fenêtre pop-up Vérifier votre compte.
  4. Cliquez sur Vérifier et enregistrer les modifications.
Une capture d'écran de la vérification des modifications apportées à une clé API

Supprimer une clé API Wix

Vous pouvez supprimer à tout moment les clés API dont vous n'avez plus besoin. 
Important :
  • Tout utilisateur ou application qui avait précédemment accès à la clé API perdra l'accès à vos données après que vous les aurez supprimées. 
  • Il n'est pas possible de récupérer une clé API après l'avoir supprimée.

Pour supprimer une clé API

  1. Accédez à Clés API dans les paramètres de votre compte.
  2. Cliquez sur l'icône Plus d'actions  à côté de la clé API que vous souhaitez supprimer.
  3. Sélectionnez Supprimer.
Une capture d'écran de la suppression d'une clé API
  1. Cliquez sur Supprimer dans la fenêtre pop-up.
  2. Cliquez sur Envoyer le code pour envoyer un code de vérification à 6 chiffres à l'adresse e-mail liée à votre compte
  3. Obtenez votre code de vérification dans l'e-mail.
  4. Saisissez le code dans la fenêtre pop-up Vérifier votre compte.
  5. Cliquez sur Vérifier et supprimer la clé.
Une capture d'écran de la vérification de la suppression d'une clé API

Choisir les autorisations de la clé API Wix

Les autorisations que vous attribuez à votre clé API contrôlent les types de données auxquelles les appels d'API à l'aide de la clé peuvent accéder.
Par exemple, vous pouvez sélectionner l'autorisation Wix Stores pour autoriser uniquement l'accès aux données de la boutique de votre site, y compris les articles, les commandes et les devises.
Important :
La plupart des autorisations donnent automatiquement un accès en lecture et en écriture aux données de votre site. Il est important de n'attribuer que les autorisations dont vous avez besoin à votre clé API afin de ne pas donner plus d'accès aux données de votre site que nécessaire. En savoir plus sur les autorisations et la sécurité des clés API
Vous pouvez consulter les autorisations d'une clé API en cliquant sur Afficher les autorisations à côté d'elle sur la page Clés API
Un GIF de la visualisation d'un ensemble d'autorisations de clés API
Vous pouvez également modifier les autorisations d'une clé API à tout moment si vous devez ajouter ou supprimer des autorisations. 

Pour modifier les autorisations d'une clé :

  1. Accédez à Clés API dans les paramètres de votre compte.
  2. Cliquez sur l'icône Plus d'actions à côté de la clé API que vous souhaitez modifier.
  3. Sélectionnez Modifier.
  4. Sélectionnez les nouvelles autorisations que vous souhaitez attribuer à la clé API sous Autorisations .
Une capture d'écran de l'ensemble d'autorisations d'une clé API
  1. Cliquez sur Enregistrer et fermer.
  2. Cliquez sur Oui, Enregistrer les modifications dans la fenêtre pop-up.
  3. Cliquez sur Envoyer le code pour envoyer un code de vérification à 6 chiffres à l'adresse e-mail liée à votre compte
  4. Obtenez votre code de vérification dans l'e-mail.
  5. Saisissez le code dans la fenêtre pop-up Vérifier votre compte.
  6. Cliquez sur Vérifier et enregistrer les modifications.
Une capture d'écran de la vérification des modifications apportées à l'ensemble d'autorisations d'une clé API

Obtenir votre identifiant de compte

Pour utiliser les API au niveau du site, vous devez inclure votre ID de compte Wix dans l'en-tête de votre demande HTTP. Vous pouvez obtenir votre identifiant de compte sur la page Clés API des paramètres de votre compte. 

Pour obtenir votre identifiant de compte :

  1. Accédez à Clés API dans les paramètres de votre compte.
  2. Cliquez sur Copier la pièce d'identité sous Identifiant du compte .
Une capture d'écran de la copie de votre identifiant de compte sur la page des clés API

Vous voulez en savoir plus sur l'utilisation des clés API Wix ?

Cela vous a-t-il aidé ?

|