Comment fonctionnent les clés API et les webhooks dans priceq ?
Mis à jour le
Équipe et compte, 9 articles
Les deux se trouvent dans Paramètres et s'adressent à un développeur. Une clé API permet à votre propre système de récupérer vos produits, vos liens et vos prix, et d'y envoyer votre catalogue. Un webhook fonctionne dans l'autre sens : priceq appelle une de vos adresses quand quelque chose se passe. La référence technique complète se trouve sur /developers.
Clés API
Seul un administrateur voit la section Clés API. Pour créer une clé :
- Indiquez à quoi sert la clé dans le champ du nom.
- Cliquez sur Créer une clé.
- Copiez la clé tout de suite. L'encadré indique Copiez cette clé maintenant, car nous ne pouvons plus l'afficher : priceq n'en garde qu'une version brouillée.
Une clé donne accès aux données, pas à l'administration. Elle ne peut ni résilier votre abonnement, ni lancer l'export complet des données, ni créer d'autres clés. Votre organisation peut avoir jusqu'à 10 clés actives en même temps.
Chaque clé apparaît dans la liste avec ses premiers caractères, sa date de création et sa dernière utilisation. Cliquez sur Révoquer pour désactiver une clé. À partir de ce moment, tout appel avec cette clé est refusé et la clé disparaît de la liste. Une clé perdue ne peut pas être récupérée : révoquez-la et créez-en une nouvelle.
Webhooks
Tout le monde voit la section Webhooks, mais ajouter, mettre en pause ou supprimer un webhook demande le rôle Superviseur ou Administrateur. Voir Les rôles et leurs droits.
Cliquez sur Ajouter un webhook, remplissez URL du point de terminaison et choisissez au moins un événement sous Envoyer sur. L'adresse doit commencer par https:// et être joignable depuis Internet. Cliquez ensuite sur Créer.
Un envoi peut partir sur ces événements :
- Alerte déclenchée
- Produit ajouté
- Produit archivé
- Prix conseillé modifié
- Analyse terminée
- Synchronisation du catalogue terminée
Après la création du webhook, priceq affiche une seule fois son secret de signature. Copiez-le tout de suite. Votre système s'en sert pour vérifier qu'un appel vient bien de priceq ; /developers explique comment.
Quand un envoi échoue
Chaque ligne se termine par un menu avec Mettre en pause, Reprendre, Supprimer et le journal d'envoi. Chaque envoi y affiche En file d'attente, Envoyé ou Échec.
Quand votre serveur est hors service, trop lent ou renvoie une erreur serveur, priceq réessaie : cinq tentatives au total, réparties sur une vingtaine de minutes. Si votre serveur répond par une erreur client comme 404, priceq s'arrête aussitôt, car une nouvelle tentative donnerait la même réponse.
Les alertes qui peuvent déclencher un webhook sont expliquées dans Qu'est-ce qui déclenche chaque type d'alerte ?.
Vous ne trouvez pas ? Écrivez-nous. Nous répondons nous-mêmes, puis nous écrivons l’article. [email protected]