Référence API

L’API Mailpulse vous permet de récupérer des statistiques de suivi et de gérer vos campagnes d’email par programmation.

Authentification

Toutes les endpoints de l’API nécessitent une authentification via une clé API. Incluez votre clé API dans l’en-tête x-api-key :

curl -X GET NEXT_PUBLIC_BASE_URL/api/stats \
  -H "x-api-key: votre-cle-api"

Vous pouvez générer une clé API depuis votre tableau de bord Mailpulse sous Paramètres > Clés API.

URL de Base

L’URL de base pour toutes les endpoints de l’API est :

https://mailpulse-io.lyten.agency/api

Pour les instances auto-hébergées, remplacez par votre propre domaine.

Format de Réponse

Toutes les réponses sont renvoyées au format JSON. Les réponses réussies renvoient les données demandées, tandis que les réponses d’erreur incluent un champ error :

{
  "error": "Campagne non trouvée"
}

Limites de débit

Les requêtes API sont limitées pour assurer une utilisation équitable. Si vous dépassez la limite, vous recevrez une réponse 429 Too Many Requests.

Endpoints Disponibles

Statistiques

• GET /api/stats - Statistiques Globales - Obtenir les statistiques globales de suivi pour votre organisation

Envoi d’Emails

• POST /api/send - Envoyer un Email - Envoyer un email avec suivi automatique

Domaines d’Envoi

• GET /api/sending-domains - Lister les Domaines - Lister vos domaines d’envoi
• POST /api/sending-domains - Ajouter un nouveau domaine d’envoi
• POST /api/sending-domains/verify - Vérifier les enregistrements DNS
• DELETE /api/sending-domains/:id - Supprimer un domaine d’envoi

Campagnes

• GET /api/campaigns - Lister les Campagnes - Lister toutes les campagnes
• GET /api/campaigns/:id - Obtenir les détails d’une campagne avec la liste des emails
• GET /api/campaigns/:id/stats - Statistiques de Campagne - Obtenir des analyses détaillées pour une campagne