मुख्य सामग्री पर जाएँ
Telm

API प्रमाणीकरण — Telm API कुंजियाँ और Bearer token

Telm REST API के साथ प्रमाणित कैसे करें: एक tk_live_ कुंजी बनाएँ, उसे Bearer token के रूप में भेजें, उसकी पहुँच समझें, और लीक हुई कुंजियाँ रद्द या घुमाएँ।

5 मिनट पढ़ें
संक्षेप में

हर Telm API अनुरोध एक API कुंजी से प्रमाणित होता है जो tk_live_ से शुरू होती है — कभी आपके डैशबोर्ड लॉगिन से नहीं। अपने खाते में एक कुंजी बनाएँ, इसे Authorization header में एक Bearer token के रूप में भेजें, और यह आपके खाते की ओर से उन ग्रुपों पर काम करती है जहाँ आप एडमिन हैं। यदि कोई कुंजी लीक हो, तो इसे डैशबोर्ड में रद्द करें और एक नई जारी करें।

खाता सेटिंग्स में API कीज़ बनाएँ और रद्द करें।

1API कुंजियाँ कैसे काम करती हैं

Telm REST API आपके ब्राउज़र सत्र का उपयोग नहीं करता। इसके बजाय, हर अनुरोध एक API कुंजी ले जाता है — एक लंबी गुप्त स्ट्रिंग जो उपसर्ग tk_live_ से शुरू होती है और उसके बाद यादृच्छिक अक्षर होते हैं। कुंजी आपके खाते की पहचान करती है और कॉल को अधिकृत करती है।

आप कुंजियाँ अपने खाते से बनाते हैं और एक बार में कई रख सकते हैं (उदाहरण के लिए, प्रति स्क्रिप्ट या सेवा एक)। पूरा गुप्त केवल एक बार, निर्माण के समय दिखाया जाता है; उसके बाद डैशबोर्ड किसी कुंजी को उसके छोटे उपसर्ग (tk_live_ और पहले अक्षर) से सूचीबद्ध करता है ताकि आप उसे पहचान सकें, और पूरा मान उसके बाद कभी नहीं रखा जाता।

  • एक कुंजी tk_live_ और उसके बाद एक लंबी यादृच्छिक स्ट्रिंग जैसी दिखती है।
  • कुंजियाँ आपके डैशबोर्ड में बनाई और प्रबंधित की जाती हैं।
  • पूरा गुप्त केवल एक बार प्रदर्शित होता है — इसे तुरंत कॉपी करें और कहीं सुरक्षित संग्रहित करें।
  • किसी कुंजी को पासवर्ड की तरह मानें: जिसके पास यह हो वह आपके रूप में API कॉल कर सकता है।
किसी API कुंजी को कभी front-end कोड, किसी सार्वजनिक repository, या किसी Telegram संदेश में न रखें। कुंजियाँ केवल आपके server पर या किसी secrets manager में रहती हैं।

2हर अनुरोध के साथ कुंजी भेजना

कुंजी को Bearer योजना का उपयोग करके Authorization header में पास करें। header मान शब्द Bearer, एक स्पेस, और फिर आपकी कुंजी है — उदाहरण के लिए, Authorization: Bearer tk_live_your_key_here।

उन क्लाइंट के लिए जो Authorization header आसानी से सेट नहीं कर सकते, API कुंजी को एक X-API-Key header में भी स्वीकार करता है। यदि दोनों मौजूद हों, तो Authorization header जीतता है। production में HTTPS के अलावा किसी चीज़ पर अनुरोध स्वीकार नहीं किए जाते।

  • पसंदीदा: Authorization: Bearer tk_live_... भेजें
  • विकल्प: इसके बजाय कुंजी को X-API-Key header में भेजें।
  • हर कॉल के लिए base URL api.telm.com/api/public/v1 है।
  • developers page पर पूरी endpoint सूची और schemas देखें।

3कोई कुंजी क्या पहुँच सकती है

एक कुंजी सख़्ती से आपके खाते की ओर से काम करती है। यह केवल उन ग्रुपों को पढ़ या बदल सकती है जहाँ आपका खाता एडमिन है — कोई अनुरोध जो किसी अन्य ग्रुप को लक्षित करे 404 लौटाता है, इसलिए API कभी यह उजागर नहीं करता कि आपके अप्रबंधनीय कोई ग्रुप मौजूद भी है।

पहुँच लक्षित ग्रुप के प्लान पर भी निर्भर करती है। spam-check endpoint दैनिक कोटा के भीतर हर प्लान के लिए खुला है, जबकि पूरा API (नियम, सेटिंग्स, whitelist, journal, analytics, batch जाँचें और webhooks) शामिल ग्रुप पर Pro प्लान या उच्चतर पर उपलब्ध है।

  • एक कुंजी केवल उन ग्रुपों को छू सकती है जहाँ आप एडमिन हैं।
  • आपके अप्रबंधनीय ग्रुपों के अनुरोध 404 लौटाते हैं, 403 नहीं।
  • दैनिक कोटा आपकी सभी कुंजियों में साझा होता है, प्रति खाता गिना जाता है।
पूरा REST API (नियम, सेटिंग्स, analytics, batch जाँचें, webhooks) Pro प्लान और ऊपर पर उपलब्ध है। एकल spam जाँचें दैनिक कोटा के भीतर हर प्लान पर काम करती हैं।

4कुंजियाँ रद्द और घुमाना

यदि कोई कुंजी उजागर हो जाए — किसी repository में कमिट, किसी चैट में चिपकाई, या किसी और तरह लीक — तो इसे अपने डैशबोर्ड से तुरंत रद्द करें। रद्दीकरण फ़ौरन प्रभावी होता है: रद्द की गई कुंजी किसी देरी के बाद नहीं, बल्कि सेकंडों में काम करना बंद कर देती है।

क्योंकि दैनिक कोटा प्रति खाता साझा होता है, एक कुंजी रद्द करना आपके उपयोग काउंटर को रीसेट नहीं करता। कुंजियाँ नियमित रूप से घुमाना अच्छी स्वच्छता है: नई कुंजी बनाएँ, इसे अपनी सेवा में तैनात करें, पुष्टि करें कि यह काम करती है, फिर पुरानी को रद्द करें ताकि कोई डाउनटाइम न हो।

  • किसी कुंजी को अपने डैशबोर्ड से रद्द करें; यह लगभग तुरंत काम करना बंद कर देती है।
  • पहले प्रतिस्थापन बनाएँ, इसे रोल आउट करें, फिर शून्य-डाउनटाइम रोटेशन के लिए पुरानी कुंजी रद्द करें।
  • कोई कुंजी रद्द करना आपका दैनिक कोटा रीसेट नहीं करता — वह मध्यरात्रि UTC पर रीसेट होता है।

5प्रमाणीकरण त्रुटियाँ

कोई गुम, विकृत, या रद्द की गई कुंजी एक मशीन-पठनीय त्रुटि कोड और एक मानव-पठनीय संदेश के साथ 401 लौटाती है। यदि आपके अनुरोध अचानक 401 के साथ विफल होने लगें, तो जाँचें कि कुंजी रद्द तो नहीं हुई और Authorization header ठीक Bearer और एक स्पेस और कुंजी के रूप में लिखा है।

एक वैध कुंजी जो किसी अप्रबंधनीय ग्रुप को लक्षित करे 404 लौटाती है। Pro से नीचे किसी प्लान पर एक वैध कुंजी जो किसी Pro-only endpoint को कॉल करे एक plan_required कोड और एक अपग्रेड संकेत के साथ 403 लौटाती है।

  • 401 — कुंजी गुम, विकृत, या रद्द है।
  • 404 — लक्षित ग्रुप मौजूद नहीं या आप उसके एडमिन नहीं हैं।
  • 403 plan_required — endpoint को उस ग्रुप पर Pro या उच्चतर चाहिए।
क्या यह लेख मददगार था?

अपने ग्रुप की रक्षा के लिए तैयार हैं?

Telm को अपने Telegram ग्रुप में जोड़ें और उसे स्पैम संभालने दें।

संबंधित लेख