API REST

L'API FluenzR vous permet d'intégrer la plateforme à vos outils et d'automatiser vos workflows.

ℹ️ Info L'API REST est disponible uniquement sur le plan Pro.

Vue d'ensemble

L'API FluenzR est une API REST qui vous permet de :

• Gérer vos contacts programmatiquement
• Créer et contrôler des campagnes
• Récupérer des statistiques
• Recevoir des webhooks sur les événements

URL de base

https://api.fluenzr.co/v1

Format des réponses

Toutes les réponses sont au format JSON :

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "perPage": 20,
    "total": 150
  }
}

En cas d'erreur

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": { ... }
  }
}

Codes HTTP

Rate limiting

Les headers de réponse indiquent votre utilisation :

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 950
X-RateLimit-Reset: 1640000000

Pagination

Les endpoints listant des ressources supportent la pagination :

GET /contacts?page=2&perPage=50

Filtrage

Filtrez les résultats avec des paramètres de requête :

GET /contacts?email=example.com&group=123

Tri

Triez les résultats :

GET /contacts?sort=createdAt&order=desc

Endpoints disponibles

Contacts

Groupes

Campagnes

Webhooks

SDKs et bibliothèques

JavaScript/TypeScript

npm install @fluenzr/sdk

import { FluenzrClient } from '@fluenzr/sdk';

const client = new FluenzrClient({
  apiKey: 'your-api-key'
});

const contacts = await client.contacts.list();

Python

pip install fluenzr

from fluenzr import FluenzrClient

client = FluenzrClient(api_key='your-api-key')
contacts = client.contacts.list()

Exemples d'utilisation

Synchroniser un CRM

// Récupérer les nouveaux contacts depuis votre CRM
const crmContacts = await myCRM.getNewContacts();

// Les créer dans FluenzR
for (const contact of crmContacts) {
  await fluenzr.contacts.create({
    email: contact.email,
    firstName: contact.first_name,
    lastName: contact.last_name,
    company: contact.company
  });
}

Automatiser une campagne

// Créer une campagne via l'API
const campaign = await fluenzr.campaigns.create({
  name: 'Automated Q1 2025',
  emailAccountId: 'acc_123',
  // ...
});

// Ajouter des contacts
await fluenzr.campaigns.addContacts(campaign.id, {
  groupId: 'grp_456'
});

// Démarrer
await fluenzr.campaigns.start(campaign.id);

Exporter des statistiques

// Récupérer les stats de toutes les campagnes
const campaigns = await fluenzr.campaigns.list();

for (const campaign of campaigns) {
  const stats = await fluenzr.campaigns.getStats(campaign.id);
  console.log(`${campaign.name}: ${stats.openRate}% opens, ${stats.replyRate}% replies`);
}

Support

Pour toute question sur l'API :

• Documentation détaillée : api.fluenzr.co/docs
• Support : api-support@fluenzr.co
• Status : status.fluenzr.co