Skip to content
Développeurs et API

Envoyer via l'API

Tout ce que propose le produit est disponible via une API REST. Branchez une fois les envois transactionnels (confirmations de commande, réinitialisations de mot de passe, alertes) dans votre backend, puis abonnez-vous aux webhooks pour les événements de livraison et d'engagement.

8 min de lecture

Ce dont vous aurez besoin

  • Un domaine d'envoi vérifié
  • Un accès administrateur pour créer une clé API
  • Un backend capable d'effectuer des requêtes HTTPS

Créer une clé API

  1. 1

    Ouvrez Paramètres → Clés API → « Créer »

    Émettez une clé limitée à ce dont elle a strictement besoin (par exemple messages:send), avec une limite de débit et une liste d'IP autorisées facultative afin qu'une clé divulguée ne puisse pas être détournée.

  2. 2

    Copiez la clé une seule fois

    La clé complète (sb_live_<prefix>.<secret>) n'est affichée qu'à la création. Conservez-la dans votre gestionnaire de secrets — elle ne peut plus être récupérée ensuite.

Les clés sont rattachées à un seul espace de travail. Une clé de l'espace A ne peut ni lire ni envoyer pour l'espace B.

S'authentifier

Chaque requête utilise un token Bearer. L'URL de base est https://api.climails.com/v1.

En-tête Authorization
Authorization: Bearer sb_live_<prefix>.<secret>

Envoyer un message

Faites un POST vers /v1/messages avec un canal, un destinataire et soit un template_id (+ variables), soit un subject/html bruts. Passez une Idempotency-Key pour qu'une requête rejouée n'envoie jamais deux fois.

Envoyer un email transactionnel
curl https://api.climails.com/v1/messages \
  -H "Authorization: Bearer sb_live_<prefix>.<secret>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1042" \
  -d '{
    "channel": "email",
    "to": "[email protected]",
    "from_email": "[email protected]",
    "subject": "Your order is confirmed",
    "html": "<p>Hi Ann, your order #1042 is on its way.</p>"
  }'
L'espace de travail est déduit automatiquement de la clé API — vous ne le placez pas dans le chemin pour /messages.

L'essayer dans le navigateur

Ouvrez Paramètres → API & Playground pour utiliser la console interactive RapiDoc : collez votre clé dans « Authenticate » et lancez de vraies requêtes avant d'écrire la moindre ligne de code. La même référence est publique sur /docs, et la spécification OpenAPI brute sur /openapi.yaml.

S'abonner aux webhooks

Enregistrez un webhook (Paramètres → Webhooks, ou POST /v1/workspaces/{workspace_id}/webhooks) pour recevoir les événements delivered, bounce, complaint, open et click, afin que votre application réagisse à ce qui se passe après l'envoi.

  • Les ressources rattachées à l'espace de travail vivent sous /v1/workspaces/{workspace_id}/… — récupérez votre workspace_id via GET /v1/workspaces.
  • Vérifiez la signature du webhook à l'aide du secret affiché lors de sa création.

Questions fréquentes

Quelle différence entre un envoi transactionnel et un envoi de campagne ?

Transactionnel = un message à une personne déclenché par votre application (POST /v1/messages). Les campagnes sont des envois en masse vers des listes/segments, planifiés depuis le cabinet ou l'API des campagnes.

Comment fonctionne l'idempotence ?

Envoyez un en-tête Idempotency-Key ; une répétition dans les 24 heures renvoie le résultat d'origine au lieu d'envoyer de nouveau.

Où trouver mon workspace_id ?

Appelez GET /v1/workspaces avec votre clé — la réponse liste l'espace de travail auquel la clé appartient.

Commencez à envoyer en quelques minutes

Créez un compte gratuit, connectez votre domaine et touchez votre audience sur tous les canaux — sans carte bancaire.

Offre gratuite à vie · Sans carte bancaire · Prêt en quelques minutes

Envoyer des messages transactionnels via l'API REST — Climails