डेवलपर्स के लिए SMLLR REST API: यह क्या करता है इसका एक सीधा जवाब

अगर आप एक SaaS प्लेटफॉर्म, ई-कॉमर्स कंपनी, या लॉजिस्टिक्स फर्म के लिए SMLLR का मूल्यांकन कर रहे हैं जिसे प्रोग्रामेटिकली हज़ारों यूनीक डायनामिक कोड जेनरेट करने की ज़रूरत है, यह पहले से जान लेना उचित है: SMLLR का पब्लिक API QR कोड नहीं बनाता या एडिट नहीं करता। यह एक रीड-ओनली रिपोर्टिंग API है — आपके अकाउंट, इंडिविजुअल QR कोड, कैंपेन, और क्लाइंट के लिए स्कैन एनालिटिक्स को आपके खुद के सिस्टम में खींचने के लिए बनाया गया। QR कोड क्रिएशन और डेस्टिनेशन-URL एडिटिंग SMLLR डैशबोर्ड के ज़रिए होती है। यह गाइड बिल्कुल यह कवर करती है कि API क्या कवर करता है, ताकि आप इसके खिलाफ बनाने से पहले तय कर सकें कि यह आपके इंटीग्रेशन में फिट बैठता है या नहीं।

ऑथेंटिकेशन एक स्टैटिक, हाई-एंट्रॉपी API की है (फॉर्मेट smllr_live_...), डैशबोर्ड में Settings → API से जेनरेट की गई — सिर्फ Premium प्लान पर उपलब्ध, बिना किसी फ्री या लोअर-टियर एक्सेस के। इसे x-api-key हेडर के तौर पर भेजें, या Authorization में एक Bearer टोकन के तौर पर। कोई OAuth2 फ्लो नहीं है, कोई स्कोप्ड/रिस्ट्रिक्टेड की नहीं है, और मैनेज करने के लिए कोई टोकन एक्सपायरी नहीं है — अगर एक की कॉम्प्रोमाइज़ हो जाए, इसे Settings से रीजेनरेट करें और पुरानी वाली तुरंत काम करना बंद कर देगी।

हर एंडपॉइंट एक GET रिक्वेस्ट है जो एक { success, data } JSON envelope रिटर्न करता है, जिसमें जहां प्रासंगिक हो period (7d/30d/90d/all) स्वीकार किया जाता है। लिस्ट एंडपॉइंट (/qrs, /campaigns, /clients) ऑफसेट-पेजिनेटेड के बजाय कर्सर-पेजिनेटेड हैं।

गैप के बारे में सीधे बात करें, क्योंकि ये वे फीचर हैं जो डेवलपर सबसे ज़्यादा मांगते हैं: एक QR कोड की डेस्टिनेशन URL बनाने या अपडेट करने के लिए कोई एंडपॉइंट नहीं है — यह सिर्फ डैशबोर्ड पर होता है। किसी भी मौजूदा सेल्फ-सर्व प्लान पर कोई बल्क/बैच क्रिएशन एंडपॉइंट नहीं है (एक CSV बल्क-क्रिएट फीचर सिर्फ थोड़े से ग्रैंडफादर्ड लीगेसी अकाउंट के लिए मौजूद है, किसी भी मौजूदा टियर पर नए ग्राहकों के लिए नहीं)। अगर आपको एक स्कैन पर रियल-टाइम रिएक्शन चाहिए, तो यह REST API का काम नहीं है — इसके बजाय Webhooks (Pro प्लान और ऊपर) इस्तेमाल करें: एक URL या एक Slack चैनल रजिस्टर करें और SMLLR इसके होते ही एक साइन्ड पेलोड पुश करता है, कोई पोलिंग ज़रूरी नहीं।

API प्रति API की प्रति मिनट 60 रिक्वेस्ट तक रेट-लिमिटेड है — एक फ्लैट लिमिट, कुछ ऐसा नहीं जो हायर प्लान पर बढ़े। यह प्रति की ट्रैक किया जाता है, इसलिए यह उसी ऑफिस नेटवर्क या NAT'd इंफ्रास्ट्रक्चर से असंबंधित ट्रैफिक के साथ शेयर नहीं होता। एक शेड्यूल्ड सिंक के लिए (जैसे हर कुछ मिनट में एक BI डैशबोर्ड रीफ्रेश करना) यह जनरस है; रियल-टाइम पोलिंग के करीब किसी भी चीज़ के लिए, आप रिक्वेस्ट को स्पेस आउट करना चाहेंगे और एक 429 पर तुरंत रीट्राई करने के बजाय बैक ऑफ करना चाहेंगे।

ऊपर बताए गए गैप के बावजूद, रिपोर्टिंग API असली-दुनिया के इंटीग्रेशन का एक असल में उपयोगी सेट कवर करता है: QR/कैंपेन/क्लाइंट स्कैन डेटा को एक इंटरनल BI टूल या Pandas पाइपलाइन में फीड करना, एक एजेंसी के लिए एक हल्का कस्टम क्लाइंट-रिपोर्टिंग व्यू बनाना (SMLLR के अपने होस्टेड क्लाइंट डैशबोर्ड के विकल्प के तौर पर), या एक डेटा वेयरहाउस में एक पीरियोडिक एक्सपोर्ट शेड्यूल करना। अगर आपकी ज़रूरत 'SMLLR से प्रोग्रामेटिकली स्कैन डेटा निकालना' है, यह अच्छी तरह फिट बैठता है। अगर आपकी ज़रूरत 'डैशबोर्ड को छुए बिना QR कोड बनाना और मैनेज करना' है, यह आज उसे कवर नहीं करता।