API क्विकस्टार्ट

यह गाइड आपको शून्य से पहले सफल अनुरोध तक ले जाएगी: पर्सनल टोकन बनाएँ, बेस एड्रेस जानें और REST एंडपॉइंट कॉल करें।

चरण 1. पर्सनल टोकन बनाएँ

पर्सनल कैबिनेट, पर्सनल टोकन सेक्शन खोलें और नया टोकन (PAT) बनाएँ। उसका मान तुरंत कॉपी करें — यह एक बार दिखाया जाता है और mbp_ प्रीफ़िक्स से शुरू होता है। बनाते समय अपने कार्य के लिए पर्याप्त एक्सेस स्कोप चुनें; विवरण — ऑथेंटिकेशन गाइड में।

चरण 2. बेस एड्रेस और फ़ॉर्मेट

सभी REST एंडपॉइंट /api प्रीफ़िक्स के अंतर्गत हैं। पथ में वर्शनिंग नहीं है। अनुरोध और रिस्पॉन्स की बॉडी — JSON; बॉडी वाले अनुरोधों के लिए Content-Type: application/json हेडर पास करें। टोकन Authorization: Bearer mbp_… हेडर से पास होता है।

चरण 3. पहला अनुरोध — बॉट की सूची

अपने बॉट की सूची के अनुरोध से टोकन जाँचें। इसके लिए bots:read (या *) स्कोप ज़रूरी है:

curl -H "Authorization: Bearer mbp_आपका_टोकन" https://your-domain/api/bots

रिस्पॉन्स में बॉट का JSON-array आएगा। अगर टोकन गलत या समाप्त हो गया — {"error":"..."} बॉडी के साथ 401 लौटेगा (देखें एरर)।

चरण 4. पहला mutation — रिएक्शन बनाएँ

रिएक्शन बनाने के लिए reactions:write स्कोप ज़रूरी है। चरण 3 से बॉट का पहचानकर्ता डालें:

curl -X POST -H "Authorization: Bearer mbp_आपका_टोकन" -H "Content-Type: application/json" -d '{"name":"नमस्ते","trigger":{"type":"command","value":"/start"}}' https://your-domain/api/bots/BOT_ID/reactions

सफल रिस्पॉन्स उसके id के साथ बनाया गया रिएक्शन लौटाएगा। बॉडी के सटीक फ़ील्ड इंटरेक्टिव संदर्भ में देखें — यह प्रत्येक एंडपॉइंट के लिए curl, JavaScript और Python में तैयार उदाहरण जनरेट करता है।

चरण 5. आगे — संदर्भ के अनुसार

जब टोकन काम करने लगे, बाकी इंटरेक्टिव संदर्भ में अधिक सुविधाजनक रूप से सीखें: वहाँ एंडपॉइंट की पूरी सूची, ज़रूरी scopes, बॉडी स्कीमा और «Try it» बटन है।

आगे क्या