SDK JavaScript

Le SDK officiel Mailpulse pour les applications JavaScript, TypeScript, React et Vue.

Installation


npm install mailpulse
# ou
pnpm add mailpulse
# ou
yarn add mailpulse

Fonctionnalités

TypeScript First - Définitions de types complètes incluses
Agnostique au Framework - Fonctionne avec vanilla JS, React, Vue, ou tout autre framework
Léger - Taille de bundle minimale avec support du tree-shaking
Moderne - Builds ESM et CommonJS disponibles

Démarrage Rapide


import { MailpulseClient } from 'mailpulse';
 
const client = new MailpulseClient({
  apiKey: 'votre-cle-api',
});
 
// Obtenir les stats globales
const stats = await client.getStats();
console.log(stats.openRate);
 
// Obtenir les campagnes
const { campaigns } = await client.getCampaigns();
 
// Obtenir les stats d'une campagne
const campaignStats = await client.getCampaignStats('campaign-id', {
  period: '30d'
});

Configuration

Option	Type	Requis	Défaut	Description
`apiKey`	`string`	Oui	-	Votre clé API Mailpulse
`apiUrl`	`string`	Non	`https://mailpulse-io.lyten.agency`	URL de base de l’API

Méthodes Disponibles

Méthode	Description
`getStats()`	Obtenir les statistiques globales de suivi
`getCampaigns()`	Lister toutes les campagnes
`getCampaign(id)`	Obtenir les détails de la campagne avec les emails
`getCampaignStats(id, options)`	Obtenir des analyses détaillées de la campagne
`registerEmail(data)`	Enregistrer un email pour le suivi

Intégrations Framework

Choisissez votre framework pour commencer :

Vanilla JavaScript - Utilisation du client principal
React - Provider et hooks
Vue - Composables pour Vue 3