ऑथेंटिकेशन और टोकन

पब्लिक API पर्सनल एक्सेस टोकन (PAT) से ऑथेंटिकेट होता है। एक टोकन अकाउंट से जुड़ा होता है और दिए गए एक्सेस स्कोप की सीमा में आपकी सभी निर्माता entities तक एक्सेस देता है।

टोकन बनाना

पर्सनल टोकन पर्सनल कैबिनेट के पर्सनल टोकन सेक्शन में बनाया जाता है। टोकन का मान बनाते समय केवल एक बार दिखाया जाता है — इसे सुरक्षित जगह सहेजें। सर्वर पर टोकन केवल हैश किए गए रूप में स्टोर होता है, इसे पुनर्प्राप्त नहीं किया जा सकता; अगर खो जाए — नया जारी करें और पुराना हटाएँ।

सभी पर्सनल टोकन mbp_ प्रीफ़िक्स से शुरू होते हैं।

टोकन पास करना

टोकन हर अनुरोध में Bearer स्कीम से HTTP हेडर Authorization में पास किया जाता है:

Authorization: Bearer mbp_आपका_टोकन

वही हेडर वेब-कैबिनेट से सेशन एक्सेस के लिए भी उपयोग होता है (वहाँ यह short-lived JWT है), लेकिन इंटीग्रेशन के लिए विशेष रूप से पर्सनल टोकन mbp_… का उपयोग करें।

एक्सेस स्कोप

टोकन के पास resource:action फ़ॉर्मेट में एक्सेस स्कोप का सेट होता है। पढ़ने के लिए :read सफ़िक्स ज़रूरी है, बदलाव के लिए — :write। उपलब्ध स्कोप:

  • bots:read, bots:write — बॉट, उनकी सेटिंग्स, सिंक्रोनाइज़ेशन, बॉट टोकन।
  • reactions:read, reactions:write — रिएक्शन, इम्पोर्ट, फ़ॉर्मूला टेस्ट, लिंक, क्रम।
  • labels:read, labels:write — सब्सक्राइबर लेबल।
  • collections:read, collections:write — संग्रह और रिकॉर्ड।
  • flows:read, flows:write — परिदृश्य।
  • integrations:read, integrations:write — इंटीग्रेशन, कनेक्शन, credentials।
  • media:write — मीडिया लाइब्रेरी में अपलोड।
  • templates:read, templates:write — बॉट टेम्प्लेट।
  • settings:read, settings:write — सेटिंग्स।
  • subscribers:read — सब्सक्राइबर और डायलॉग इतिहास (केवल पढ़ना)।
  • broadcasts:write — ब्रॉडकास्ट और उनका प्रबंधन।
  • stats:read — आँकड़े और एनालिटिक्स।
  • billing:read — बैलेंस और प्लान (केवल पढ़ना)।

विशेष स्कोप * सभी पब्लिक एंडपॉइंट तक पूर्ण एक्सेस देता है।

टोकन से क्या उपलब्ध है और क्या नहीं

पर्सनल टोकन से केवल निर्माता एंडपॉइंट उपलब्ध हैं — वे जो «बॉट बनाने में मदद करते हैं»। PAT से उपलब्ध नहीं (केवल वेब-सेशन से): लॉगिन और रजिस्ट्रेशन, मोबाइल एंडपॉइंट, भुगतान और बैलेंस टॉप-अप, नोटिफ़िकेशन, ऑडिट जर्नल, ऑपरेटर द्वारा डायलॉग में संदेश भेजना, इनकमिंग वेबहुक और भुगतान callback, WebSocket। इस तरह के रूट पर mbp_-टोकन से अनुरोध 401 या 403 लौटाएगा।

अगर टोकन में किसी विशेष रूट के लिए ज़रूरी स्कोप नहीं है — 403 मिलेगा। कोड के बारे में अधिक — एरर गाइड में।

आगे क्या