फीचर
SMLLR API: स्कैन एनालिटिक्स, प्रोग्रामेटिक रूप से।
अपने खुद के सिस्टम में SMLLR स्कैन, कैंपेन, और क्लाइंट एनालिटिक्स खींचने के लिए एक रीड-ओनली REST API — यह क्या करता है और क्या नहीं इसकी पूरी जानकारी।
एक रिपोर्टिंग API, जनरेशन API नहीं
SMLLR REST API (Premium प्लान) रीड-ओनली है: यह स्कैन, कैंपेन, और क्लाइंट एनालिटिक्स को JSON के तौर पर लौटाता है। यह QR कोड नहीं बनाता या एडिट नहीं करता — QR कोड क्रिएशन और डेस्टिनेशन-URL बदलाव सिर्फ SMLLR डैशबोर्ड के ज़रिए होते हैं। यह एक जानबूझकर, पहले से बताया गया अंतर है जो प्रोग्रामेटिक QR जनरेशन की ज़रूरत वाले इंटीग्रेशन के लिए SMLLR का मूल्यांकन करने से पहले जानना ज़रूरी है।
- GET /summary — एक अवधि के लिए अकाउंट-वाइड स्कैन टोटल
- GET /qrs और GET /qr/:id — अपने QR कोड की लिस्ट देखें, या एक के लिए पूरा एनालिटिक्स खींचें
- GET /campaigns और GET /campaign/:id — कैंपेन-लेवल एग्रीगेटेड एनालिटिक्स
- GET /clients और GET /client/:id — एजेंसियों के लिए, प्रति-क्लाइंट एग्रीगेटेड एनालिटिक्स
- प्रति अकाउंट एक सिंगल स्टैटिक API की, x-api-key हेडर या Bearer टोकन के तौर पर भेजी गई
- प्रति API की 60 रिक्वेस्ट प्रति मिनट, एक फ्लैट लिमिट जो प्लान टियर के साथ नहीं बढ़ती
API में क्या नहीं है
कमियों के बारे में सीधे बात करें: कोई ऐसा एंडपॉइंट नहीं है जो एक QR कोड बनाए या उसका डेस्टिनेशन URL अपडेट करे — वह सिर्फ डैशबोर्ड पर है। किसी भी मौजूदा सेल्फ-सर्व प्लान पर कोई बल्क/बैच क्रिएशन एंडपॉइंट नहीं है। अगर आपके इंटीग्रेशन को प्रोग्रामेटिक रूप से QR कोड जनरेट करने की ज़रूरत है, तो API आज इसे कवर नहीं करता — लेकिन अगर आपको पोलिंग के बजाय स्कैन होते ही तुरंत प्रतिक्रिया देने की ज़रूरत है, तो नीचे Webhooks देखें।
API असल में किस चीज़ के लिए अच्छा है
उन कमियों के बावजूद, रिपोर्टिंग API असल में उपयोगी इंटीग्रेशन का एक सेट कवर करता है: QR, कैंपेन, और क्लाइंट स्कैन डेटा को एक इंटरनल BI टूल या एक Python/Pandas पाइपलाइन में फीड करना, एक एजेंसी के लिए एक हल्का कस्टम क्लाइंट-रिपोर्टिंग व्यू बनाना, या एक डेटा वेयरहाउस में एक पीरियोडिक एक्सपोर्ट शेड्यूल करना। अगर ज़रूरत है 'SMLLR से प्रोग्रामेटिक रूप से स्कैन डेटा निकालना,' तो यह अच्छी तरह फिट बैठता है।
ऑथेंटिकेशन और रेट लिमिट
ऑथेंटिकेशन एक सिंगल स्टैटिक API की है (फॉर्मेट smllr_live_...) जो Settings → API से जनरेट होती है — सिर्फ Premium प्लान, कोई OAuth फ्लो नहीं और कोई टोकन एक्सपायरी मैनेज करने की ज़रूरत नहीं। रेट लिमिट एक फ्लैट 60 रिक्वेस्ट प्रति मिनट प्रति की है, IP या अकाउंट के बजाय प्रति की ट्रैक की गई, इसलिए यह उसी नेटवर्क से चल रहे असंबंधित इंटीग्रेशन के साथ शेयर नहीं होती।
MCP के ज़रिए कनेक्ट करें
वही रिपोर्टिंग API एक MCP (Model Context Protocol) सर्वर के तौर पर भी उपलब्ध है — @smllr/mcp-server — ताकि Claude या कोई भी अन्य MCP-कम्पैटिबल AI एजेंट सीधे, सादी भाषा में, उसी API की का इस्तेमाल करके आपके स्कैन, कैंपेन, और क्लाइंट एनालिटिक्स क्वेरी कर सके। यह ऊपर के ठीक 7 एंडपॉइंट को एक-से-एक रैप करता है: वही रीड-ओनली स्कोप, वही Premium-प्लान ज़रूरत, वही 60-रिक्वेस्ट-प्रति-मिनट लिमिट, और यह कभी Lead Hub कॉन्टैक्ट डेटा नहीं लौटाता। सेटअप एक कमांड है: claude mcp add smllr --env SMLLR_API_KEY=your_key -- npx -y @smllr/mcp-server। पूरी जानकारी API डॉक्स और Help Centre में है।
पोलिंग के बजाय रियल-टाइम चाहिए? Webhooks इस्तेमाल करें
REST API और MCP सर्वर दोनों पुल-बेस्ड हैं — आप पूछते हैं, वे जवाब देते हैं। अगर आपको एक शेड्यूल पर पोलिंग करने के बजाय स्कैन होते ही तुरंत प्रतिक्रिया देने की ज़रूरत है, तो SMLLR के पास आउटबाउंड webhooks भी हैं (Pro प्लान और उससे ऊपर): एक URL रजिस्टर करें और SMLLR हर QR स्कैन पर उसे एक साइन्ड JSON पेलोड POST करता है। पूरी पेलोड संरचना और सिग्नेचर वेरिफिकेशन के लिए Webhooks फीचर पेज देखें।
अक्सर पूछे जाने वाले सवाल
क्या SMLLR एक REST API ऑफर करता है?
हां, Premium प्लान पर — लेकिन यह एक रीड-ओनली रिपोर्टिंग API है। यह स्कैन, कैंपेन, और क्लाइंट एनालिटिक्स को JSON के तौर पर लौटाता है; यह QR कोड नहीं बनाता या एडिट नहीं करता।
क्या SMLLR के पास AI एजेंट के लिए एक MCP सर्वर है?
हां — @smllr/mcp-server उसी रीड-ओनली रिपोर्टिंग API को टूल के तौर पर रैप करता है जिन्हें Claude और अन्य MCP-कम्पैटिबल एजेंट सीधे कॉल कर सकते हैं। वही Premium-प्लान ज़रूरत, वही 60-req/min लिमिट, और यह कभी Lead Hub कॉन्टैक्ट डेटा एक्सपोज़ नहीं करता — सिर्फ एग्रीगेटेड स्कैन, कैंपेन, और क्लाइंट एनालिटिक्स।
क्या मैं API का इस्तेमाल करके QR कोड बना या जनरेट कर सकता हूं?
नहीं। QR कोड क्रिएशन और डेस्टिनेशन-URL एडिटिंग सिर्फ SMLLR डैशबोर्ड के ज़रिए होते हैं। API स्कैन डेटा बाहर खींचने के लिए है, कोड बनाने के लिए नहीं।
क्या API रियल-टाइम स्कैन इवेंट के लिए webhooks सपोर्ट करता है?
REST API और MCP सर्वर दोनों पुल-बेस्ड हैं (एक शेड्यूल पर पोल करते हैं)। रियल-टाइम पुश के लिए, SMLLR के पास एक अलग आउटबाउंड webhooks फीचर है (Pro प्लान और उससे ऊपर) — Webhooks फीचर पेज देखें।
मैं SMLLR API के साथ कैसे ऑथेंटिकेट करूं?
एक सिंगल स्टैटिक API की, जो Settings → API से जनरेट होती है। इसे x-api-key हेडर के तौर पर या Authorization हेडर में Bearer टोकन के तौर पर भेजें।
API के लिए रेट लिमिट क्या है?
प्रति API की 60 रिक्वेस्ट प्रति मिनट — एक फ्लैट लिमिट जो हायर प्लान पर नहीं बढ़ती, आपके अकाउंट या नेटवर्क में शेयर होने के बजाय प्रति की ट्रैक की जाती है।
क्या मैं API के ज़रिए QR कोड बल्क-क्रिएट कर सकता हूं?
किसी भी मौजूदा सेल्फ-सर्व प्लान पर नहीं। आज Starter, Basic, Pro, या Premium ग्राहकों के लिए कोई बल्क/बैच QR-क्रिएशन एंडपॉइंट नहीं है।
क्या API एक्सेस सभी प्लान पर उपलब्ध है?
नहीं। API एक्सेस सिर्फ Premium प्लान पर उपलब्ध है; निचले टियर डैशबोर्ड इंटरफेस तक सीमित हैं।
मैं असल में इस API से क्या बना सकता हूं?
कोई भी चीज़ जिसे SMLLR से प्रोग्रामेटिक रूप से खींचे गए स्कैन, कैंपेन, या क्लाइंट एनालिटिक्स की ज़रूरत हो — एक BI डैशबोर्ड, एक Python डेटा पाइपलाइन, एक कस्टम क्लाइंट-रिपोर्टिंग व्यू, या एक डेटा वेयरहाउस में एक शेड्यूल्ड एक्सपोर्ट।
हर फीचर अनलॉक करें
3 स्टैटिक QR कोड के साथ मुफ्त में शुरू करें। डायनामिक QR कोड, ज़्यादा कोड, और स्कैन एनालिटिक्स अनलॉक करने के लिए कभी भी अपग्रेड करें।