Vous envoyez des événements de liste de souhaits dans votre boutique depuis un autre système ? Le webhook entrant de SaveTo Wishlist Pro nécessite désormais une clé d'API avant d'accepter quoi que ce soit, de sorte qu'un site qui n'en a pas généré une refuse chaque requête au lieu de l'accepter sans vérification. Ceci explique où générer cette clé, comment votre intégration doit l'envoyer et à quoi s'attendre si elle est manquante ou incorrecte. L'envoi d'événements dans l'autre sens, depuis votre boutique, est abordé dans Comment connecter des outils externes à l'aide des webhooks de liste de souhaits.
Avant de commencer
- SaveTo Wishlist Pro est installé et actif.
- Vous avez accès au système externe qui enverra les événements de liste de souhaits, vous pouvez donc stocker la clé dont il a besoin pour l'envoyer avec chaque requête.
Générer la clé d'API du webhook
Tant qu'une clé n'existe pas, le point de terminaison du webhook refuse chaque requête, c'est donc la première chose à faire.
- Allez dans SaveTo Wishlist > Paramètres.
- Cliquez sur l'onglet Général.
- Dans la section API du webhook, cliquez sur Générer la clé d'API et confirmez lorsque vous y êtes invité.
- Copiez la valeur qui apparaît dans le champ Clé d'API du webhook de liste de souhaits.
Le champ Clé d'API du webhook de liste de souhaits accepte également une clé que vous tapez vous-même, si votre système externe a besoin de fournir sa propre valeur au lieu d'en utiliser une générée. Dans tous les cas, cliquez sur Enregistrer les modifications pour la stocker.
Envoyez la clé avec vos requêtes
Configurez votre système externe pour envoyer la clé à chaque appel de POST /wp-json/saveto-wishlist-pro/v1/webhook/wishlist-created. Il existe deux façons de l'envoyer :
- En tant qu'en-tête de requête x-api-key. C'est la méthode préférée.
- En tant que paramètre de chaîne de requête api_key, si votre système ne peut pas définir d'en-têtes personnalisés.
Copiez la clé exactement comme elle apparaît dans le champ Clé d'API du webhook de liste de souhaits, sans espaces supplémentaires ni sauts de ligne ajoutés avant ou après. La comparaison est sensible à la casse, donc une clé qui ne correspond pas exactement est traitée comme une clé manquante.
Ce qui se passe lorsque la clé est manquante ou incorrecte
Une requête sans clé valide reçoit une réponse 401 Unauthorized au lieu d'être traitée, que la clé soit manquante, ne corresponde pas à ce qui est stocké dans les Paramètres, ou n'ait pas encore été générée sur votre boutique. Ceci est vrai même pour un site qui n'a jamais généré de clé : sans rien à comparer, tous les appelants sont refusés plutôt que laissés passer.
Cliquer à nouveau sur Générer la clé d'API remplace immédiatement la clé stockée. Tout système envoyant toujours l'ancienne clé commence à être refusé immédiatement, alors mettez à jour votre intégration avec la nouvelle valeur dès que vous la régénérez.
Dépannage
Chaque requête envoyée au webhook reçoit une réponse 401
Vérifiez qu'une clé a bien été générée dans SaveTo Wishlist > Paramètres > Général, sous API Webhook. Si le champ est vide, générez-en une et enregistrez vos modifications. Si une clé est déjà présente, confirmez que votre intégration l'envoie en tant qu'en-tête x-api-key (ou en tant que paramètre de requête api_key) et qu'elle a été copiée sans aucun espace blanc autour.
L'intégration fonctionnait auparavant, mais maintenant chaque requête échoue
Cela signifie généralement que la clé a été régénérée dans l'onglet Général depuis la dernière mise à jour de l'intégration. La génération d'une nouvelle clé remplace immédiatement l'ancienne. Mettez donc à jour le système appelant avec la valeur actuelle du champ Clé API Webhook de la liste de souhaits.
Questions fréquemment posées
Que se passe-t-il si je ne génère jamais de clé ?
Le point de terminaison du webhook refuse chaque requête. Une clé vide ne peut jamais correspondre à ce qu'un appelant envoie, c'est donc la même chose que si le point de terminaison était désactivé.
Puis-je utiliser la chaîne de requête au lieu d'un en-tête ?
Oui. Envoyez api_key=votre-clé en tant que paramètre de requête si votre système ne peut pas définir l'en-tête x-api-key. L'en-tête est vérifié en premier, il a donc la priorité si les deux sont présents.
La régénération de la clé casse-t-elle mon intégration existante ?
Oui, immédiatement. L'ancienne clé cesse de fonctionner dès que vous cliquez à nouveau sur Générer la clé API. Ne la régénérez donc que lorsque vous êtes prêt à mettre à jour le système appelant avec la nouvelle valeur en même temps.
Besoin d'aide ?
- Utilisateurs premium : Ouvrir un ticket de support
- Utilisateurs gratuits : Visitez notre forum communautaire
