REST API

FluenzR API आपको प्लेटफ़ॉर्म को अपने टूल के साथ एकीकृत करने और अपने वर्कफ़्लो को स्वचालित करने देता है।

जानकारी REST API केवल Pro योजना पर उपलब्ध है।

अवलोकन

FluenzR API एक REST API है जो आपको अनुमति देता है:

• अपने संपर्कों को प्रोग्रामेटिक रूप से प्रबंधित करें
• अभियान बनाएं और नियंत्रित करें
• आंकड़े प्राप्त करें
• घटनाओं पर webhooks प्राप्त करें

आधार URL

https://api.fluenzr.co/v1

प्रतिक्रिया प्रारूप

सभी प्रतिक्रियाएं JSON प्रारूप में हैं:

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

त्रुटि पर

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

HTTP कोड

दर सीमा

प्रतिक्रिया हेडर आपके उपयोग को इंगित करते हैं:

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

पृष्ठांकन

संसाधन सूचीबद्ध करने वाले एंडपॉइंट पृष्ठांकन का समर्थन करते हैं:

GET /contacts?page=2&perPage=50

फ़िल्टरिंग

क्वेरी पैरामीटर के साथ परिणाम फ़िल्टर करें:

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

सॉर्टिंग

परिणाम क्रमबद्ध करें:

GET /contacts?sort=createdAt&order=desc

उपलब्ध एंडपॉइंट

संपर्क

समूह

अभियान

Webhooks

SDK और लाइब्रेरी

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()

उपयोग उदाहरण

CRM सिंक करें

// अपने CRM से नए संपर्क प्राप्त करें
const crmContacts = await myCRM.getNewContacts();

// उन्हें FluenzR में बनाएं
for (const contact of crmContacts) {
  await fluenzr.contacts.create({
    email: contact.email,
    firstName: contact.first_name,
    lastName: contact.last_name,
    company: contact.company
  });
}

अभियान स्वचालित करें

// API के माध्यम से अभियान बनाएं
const campaign = await fluenzr.campaigns.create({
  name: 'Automated Q1 2025',
  emailAccountId: 'acc_123',
  // ...
});

// संपर्क जोड़ें
await fluenzr.campaigns.addContacts(campaign.id, {
  groupId: 'grp_456'
});

// प्रारंभ करें
await fluenzr.campaigns.start(campaign.id);

आंकड़े निर्यात करें

// सभी अभियानों के लिए आंकड़े प्राप्त करें
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`);
}

समर्थन

किसी भी API प्रश्न के लिए:

• विस्तृत दस्तावेज़: api.fluenzr.co/docs
• समर्थन: api-support@fluenzr.co
• स्थिति: status.fluenzr.co