Où trouver l'API ?

Va dans Paramètres → API. La page comporte trois onglets : Clés, Webhooks et Activité. Seuls les utilisateurs ayant le rôle Propriétaire voient cette page.

  • URL de base : https://api.v2.xendy.me/v1
  • Documentation (OpenAPI) : https://api.v2.xendy.me/v1/openapi.json. Tu l'ouvres sans clé API et tu peux l'importer dans des outils comme Postman.

Créer une clé API

  1. Clique sur l'onglet Clés, puis sur Créer une clé API.
  2. Donne à la clé un Nom reconnaissable, par exemple Connexion boutique en ligne.
  3. Choisis pour chaque type de données ce que la clé est autorisée à faire : Lire et/ou Écrire. N'accorde pas plus de droits que ce dont ta connexion a besoin.
  4. Clique sur Créer. Copie la clé et clique sur J'ai sauvegardé la valeur. Tu ne verras la clé qu'une seule fois.

Envoie la clé dans chaque requête sous forme d'en-tête : Authorization: Bearer xnd_live_.... La clé détermine automatiquement le compte concerné.

Type de donnéesLireÉcrire
ContactsRécupérer des contactsCréer, mettre à jour, inscrire et désinscrire des contacts, les ajouter à une liste ou les en retirer
Listes de diffusion & audiencesRécupérer des listes et des segmentsCréer une liste
CampagnesRécupérer des campagnes–
Envoi–Envoyer ou planifier une campagne existante en tant que newsletter
RapportsRécupérer les statistiques des newsletters et des automations–
CompteLe token pour les paniers abandonnés (nécessaire pour le plugin WordPress)–
WebhooksRécupérer des webhooksEnregistrer et supprimer des webhooks

Attention : avec Envoi (écriture), la clé peut envoyer de vraies newsletters à tes contacts. N'active cette option que si ta connexion en a besoin.

Révoquer une clé API

Dans la liste des clés, tu vois pour chaque clé les Droits et la date de dernière utilisation (Dernière utilisation). Si tu ne veux plus utiliser une clé, clique sur l'icône de corbeille sous Supprimer et confirme. Les connexions utilisant cette clé cesseront immédiatement de fonctionner. Cette action est irréversible.

Webhooks : Xendy t'envoie un message

Avec un webhook, Xendy envoie automatiquement une requête POST à ton URL lorsqu'un événement se produit. Tu choisis parmi trois événements :

  • Enregistrements DNS incorrects (dns-records.failed)
  • Enregistrements DNS rétablis (dns-records.recovered)
  • Importation boutique en ligne échouée (webshop-import.failed)
  1. Clique sur l'onglet Webhooks, puis sur Ajouter un webhook.
  2. Renseigne l'URL (https uniquement) et choisis les Événements.
  3. Clique sur Ajouter. Copie le secret webhook qui s'affiche : tu ne le verras qu'une seule fois.

Chaque message est au format JSON avec id, event, created_at et data, et contient les en-têtes Xendy-Event, Xendy-Delivery et Xendy-Signature. La signature te permet de vérifier que le message provient bien de Xendy. Xendy-Signature a la forme t=<horodatage>,v1=<signature> : la signature est un HMAC-SHA256 de <t>.<body> avec ton secret. Refuse les messages dont t date de plus de 5 minutes. Un exemple en JavaScript est disponible dans la documentation.

Réponds dans les 10 secondes avec un code de statut 2xx. Si la livraison échoue, Xendy réessaie après 1, 5 et 30 minutes. Si cinq événements consécutifs échouent complètement, Xendy met le webhook en Désactivé. Chaque tentative est visible dans l'onglet Activité, sous Webhook sortant.

Limites

  • 120 requêtes par minute par clé
  • Actions d'écriture : 60 par minute
  • Envoi : 10 par minute

Si tu dépasses ces limites, tu reçois une erreur HTTP 429. Lors de l'envoi d'une newsletter, inclus un en-tête Idempotency-Key : dans les 24 heures, la même valeur renvoie la même newsletter au lieu de déclencher un second envoi.

Questions fréquentes

Non. Xendy n'affiche une clé qu'une seule fois et ne la conserve pas en clair. Crée une nouvelle clé, intègre-la dans ta connexion, puis révoque l'ancienne.

Non. Une clé API (xnd_live_...) fonctionne uniquement sur l'API et une clé MCP (xnd_mcp_...) uniquement pour les assistants IA via MCP. Avec une clé MCP, l'API renvoie le code d'erreur 401.

Cinq événements consécutifs n'ont pas pu être livrés, même après les nouvelles tentatives. Dans l'onglet Activité (type Webhook sortant), tu peux voir ce que ton serveur a répondu. Résous le problème, supprime le webhook et ajoute-le à nouveau.

Dans l'onglet Webhooks, tu configures les messages que Xendy envoie à ton système. Si tu veux toi-même envoyer des contacts vers Xendy, utilise dans un segment Ajouter des contacts → Via un webhook. Cela fonctionne avec un token dédié plutôt qu'une clé API. Voir Connecter via Zapier.

Dans l'onglet Activité, tu vois chaque appel avec son statut, sa durée et les données envoyées. Voir Consulter l'activité API.

Joeri Ras

Rédigé par

Joeri Ras

Fondateur & copropriétaire @ Xendy

Tu préfères un contact direct ?

Articles associés

Intégrations

Connecter Gravity Forms à Xendy

Avec Gravity Forms, tu crées facilement des formulaires dans WordPress. Grâce à la connexion avec Xendy, les soumissions arrivent automatiquement dans un segment statique, ce qui te permet d'utiliser tes nouveaux contacts directement pour des newsletters ou des automatisations d'e-mails.

Lire la suite
Intégrations

Connecter ta boutique Lightspeed à Xendy

En connectant Lightspeed à Xendy, les données clients, commandes et produits sont automatiquement synchronisées chaque nuit. Tu peux ainsi créer des segments basés sur le comportement d'achat et afficher des produits directement dans tes e-mails. Avec deux scripts dans ta boutique en ligne, tu peux également faire le suivi des paniers abandonnés.

Lire la suite
Intégrations

Connecter ta boutique Magento 2 à Xendy

En connectant Magento 2 à Xendy, les données clients, commandes et produits sont automatiquement synchronisées chaque nuit. Tu peux ainsi créer des segments basés sur le comportement d'achat, afficher des recommandations de produits personnalisées et effectuer un suivi des paniers abandonnés. Attention : les paniers abandonnés ne fonctionnent avec Magento 2 que pour les clients connectés à ta boutique en ligne. Xendy les récupère lors de l'importation nocturne.

Lire la suite
Intégrations

Connecter ta boutique Shopify à Xendy

En connectant Shopify à Xendy, tes clients, commandes et produits arrivent dans Xendy. Tu peux ainsi créer des segments basés sur le comportement d'achat et insérer des produits dans tes e-mails. La connexion se fait via l'application Xendy dans Shopify ou avec une application personnalisée depuis le Shopify Dev Dashboard. Avec l'application Xendy, les modifications arrivent immédiatement, les paniers abandonnés fonctionnent et les désinscriptions sont synchronisées dans les deux sens. Avec une application personnalisée, tes données sont mises à jour chaque nuit.

Lire la suite