आपके ऐप का REST API और API डॉक्स

कभी-कभी दूसरे सॉफ़्टवेयर को आपके ऐप के डेटा की ज़रूरत होती है: किसी पार्टनर की वेबसाइट जो आपके प्रोडक्ट दिखाती है, कोई स्प्रेडशीट जो नए ऑर्डर खींचती है, कोई मोबाइल ऐप, या Zapier या n8n जैसा कोई ऑटोमेशन टूल। ये आपके ऐप से एक API के ज़रिए बात करते हैं — वेब पतों (एंडपॉइंट) का एक सेट, जो पेज की जगह डेटा लौटाता है। REST API इसका सबसे आम प्रकार है।

MonstarX आपके लिए बिना कोड के एक API बना देता है। आप चुनते हैं कि क्या साझा करना है, और वह कुछ ही सेकंड में लाइव हो जाता है, साथ में एक संदर्भ पेज जिसे डेवलपर पढ़ सकें।

यह कहाँ मिलेगा?

अपना प्रोजेक्ट खोलें, ऊपर की पट्टी में एडमिन पर क्लिक करें, फिर एडमिन के साइडबार में API पर। आपको प्रोजेक्ट API दिखता है: सबसे ऊपर API संदर्भ की पट्टी, जो आपके API डॉक्स प्रकाशित करती है; बाईं ओर आपके एंडपॉइंट, हर एक पर लाइव या ड्राफ़्ट लिखा; और उनके नीचे API कुंजियाँ।

एंडपॉइंट कैसे बनाऊँ?

1. एडमिन›API में नया एंडपॉइंट पर क्लिक करें (या एंडपॉइंट के बगल में + पर)।

2. कलेक्शन चुनें — वह टेबल जिस पर एंडपॉइंट काम करेगा, जैसे रेसिपी वाली टेबल।

3. ऑपरेशन चुनें:

   ऑपरेशन	मेथड और पता	यह क्या करता है
   सूची पाएँ	GET /recipes	रिकॉर्ड लौटाता है, एक बार में एक पेज।
   रिकॉर्ड पाएँ	GET /recipes/{id}	id से एक रिकॉर्ड लौटाता है।
   बनाएँ	POST /recipes	एक रिकॉर्ड जोड़ता है।
   अपडेट करें	PATCH /recipes/{id}	किसी रिकॉर्ड के कुछ फ़ील्ड बदलता है।
   हटाएँ	DELETE /recipes/{id}	एक रिकॉर्ड हटाता है।

4. उसे एक नाम, एक URL पथ और चाहें तो एक विवरण दें। ये API डॉक्स में दिखते हैं।

5. उपलब्ध कराए गए फ़ील्ड में ठीक वही फ़ील्ड चुनें जिन्हें कॉल करने वाले देख या भेज सकें। जो नहीं चुना, वह निजी रहता है। संवेदनशील दिखने वाले फ़ील्ड, जैसे पासवर्ड और टोकन, हमेशा बाहर रखे जाते हैं।

6. पहुँच में चुनें कि इसे कौन कॉल कर सकता है (नीचे देखें)।

7. एंडपॉइंट प्रकाशित करें पर टिक लगाएँ और एंडपॉइंट सहेजें और प्रकाशित करें पर क्लिक करें। प्रकाशित एंडपॉइंट लाइव होता है: वह तुरंत अनुरोधों का जवाब देने लगता है। बॉक्स पर टिक न लगाएँ, तो एंडपॉइंट सहेजें उसे ड्राफ़्ट के रूप में रखता है।

   

सूची में हर एंडपॉइंट पर लाइव या ड्राफ़्ट लिखा होता है। यही शब्द एंडपॉइंट संपादित करें के नीचे भी दिखता है, और सेव करने तक उसके बाद बिना सहेजे बदलाव लिखा रहता है। किसी एंडपॉइंट को हटाए बिना ऑफ़लाइन करने के लिए एंडपॉइंट प्रकाशित करें से टिक हटाएँ और सेव करें; हटाएँ उसे पूरी तरह हटा देता है।

टिप्पणी

बनाएँ, अपडेट करें और हटाएँ आपके असली डेटा को बदलते हैं। इनमें से किसी को प्रकाशित करने से पहले, एडमिन टैब में उस टेबल की सेटिंग्स में वह काम (जोड़ना, बदलना या हटाना) चालू करें। देखें आपके ऐप का एडमिन पैनल।

मेरे एंडपॉइंट कौन कॉल कर सकता है?

पहुँच	कौन कॉल कर सकता है	किसके लिए
सार्वजनिक पढ़ने की अनुमति	जिसके पास भी पता हो।	सिर्फ़ सूची पाएँ और रिकॉर्ड पाएँ
प्रोजेक्ट API कुंजी	सिर्फ़ वे कॉल करने वाले जो आपके प्रोजेक्ट की कोई API कुंजी भेजें।	हर ऑपरेशन

डेटा बदलने वाले एंडपॉइंट के लिए हमेशा कुंजी चाहिए।

API कुंजी कैसे बनाऊँ?

1. एडमिन›API में API कुंजियाँ पर क्लिक करें।

2. ऐसा नाम लिखें जिससे पता चले कि कुंजी कहाँ इस्तेमाल होगी, जैसे “रेसिपी विजेट सर्वर”, और कुंजी बनाएँ पर क्लिक करें।

3. कुंजी तुरंत कॉपी करें — यह mxapi_ से शुरू होती है और इसे दोबारा नहीं दिखाया जा सकता। इसे किसी सुरक्षित जगह रखें, जैसे पासवर्ड मैनेजर या दूसरी सेवा के सीक्रेट में।

एक कुंजी प्रोजेक्ट के हर कुंजी-सुरक्षित एंडपॉइंट को खोलती है, इसलिए हर सेवा को उसकी अपनी कुंजी दें। किसी कुंजी को बंद करने के लिए रद्द करें पर क्लिक करें; उसे इस्तेमाल करने वाली हर चीज़ तुरंत काम करना बंद कर देती है।

कॉल करने वाले कुंजी को Authorization हेडर में भेजते हैं: Authorization: Bearer mxapi_…।

सावधानी

API कुंजियाँ सर्वर पर ही रखें। किसी वेब पेज या मोबाइल ऐप में रखी कुंजी को कोई भी देखकर पढ़ सकता है।

किसी एंडपॉइंट को कैसे आज़माऊँ?

एंडपॉइंट खोलें और टेस्ट पर क्लिक करें। अगर एंडपॉइंट को ज़रूरत हो तो रिकॉर्ड ID, Bearer कुंजी या JSON बॉडी भरें और अनुरोध भेजें पर क्लिक करें। आपको स्थिति (200 का मतलब है कि काम हो गया), लगा हुआ समय और जवाब दिखता है। जिस एंडपॉइंट को कुंजी चाहिए, उसके लिए API कुंजियाँ से अपनी कोई कुंजी Bearer कुंजी में पेस्ट करें।

टेस्ट असली, लाइव एंडपॉइंट पर जाते हैं, इसलिए:

• ड्राफ़्ट को अभी टेस्ट नहीं किया जा सकता। टेस्ट टैब में यह एंडपॉइंट अभी ड्राफ़्ट है लिखा आता है; उसे प्रकाशित करके टेस्ट करने के लिए वहीं एंडपॉइंट सहेजें और प्रकाशित करें पर क्लिक करें।
• पहले अपने बदलाव सेव करें। बिना सेव किए बदलाव हों, तो टेस्ट टैब टेस्ट से पहले सेव करने को कहता है, साथ में एंडपॉइंट सहेजें बटन होता है।

बनाएँ, अपडेट करें या हटाएँ का टेस्ट आपके असली डेटा को बदल देता है।

कोड टैब में कॉपी करने के लिए तैयार cURL कमांड है, और OpenAPI JSON फ़ाइल भी, जिसे Postman और Insomnia जैसे API टूल आयात कर सकते हैं।

अपने API डॉक्स कैसे प्रकाशित और साझा करूँ?

आपके API डॉक्स डेवलपर के लिए एक API संदर्भ पेज हैं: हर लाइव एंडपॉइंट, उसके फ़ील्ड, उसे कुंजी चाहिए या नहीं, एक आज़माएँ बॉक्स और एक cURL उदाहरण। एंडपॉइंट प्रकाशित करने से डॉक्स प्रकाशित नहीं होते — उन्हें कब साझा करना है, यह आप तय करते हैं।

1. कम से कम एक एंडपॉइंट प्रकाशित करें, और सारे बदलाव सेव करें। तब तक एडमिन›API में सबसे ऊपर की API संदर्भ पट्टी पर अप्रकाशित लिखा रहता है और वह बताती है कि क्या बाकी है।

2. डॉक्स प्रकाशित करें पर क्लिक करें।

   

3. अब पट्टी पर प्रकाशित लिखा आता है। पता साझा करने के लिए डॉक्स का लिंक कॉपी करें पर क्लिक करें, या पेज देखने के लिए API कुंजियाँ के नीचे API डॉक्स खोलें पर। पता कुछ ऐसा दिखता है: https://monstarx.com/api-docs/<your project id>।

monstarx.com

पेज की शुरुआत में आपके प्रोजेक्ट का नाम और विवरण, उसमें कितने एंडपॉइंट हैं, प्रोजेक्ट ID और बेस पता होता है। लिंक वाला कोई भी इसे पढ़ सकता है, और सर्च इंजन से कहा जाता है कि वे इसे इंडेक्स न करें। इसमें सिर्फ़ लाइव एंडपॉइंट दिखते हैं और कुंजियाँ कभी नहीं दिखतीं। सबसे ऊपर OpenAPI JSON इसी विवरण की फ़ाइल का लिंक है।

डॉक्स हटाने के लिए डॉक्स अप्रकाशित करें पर क्लिक करें: पेज और उसकी OpenAPI फ़ाइल काम करना बंद कर देते हैं, जबकि आपके एंडपॉइंट जवाब देते रहते हैं। अगर आप हर एंडपॉइंट ऑफ़लाइन कर देते हैं, तो डॉक्स भी अप्रकाशित हो जाते हैं, और तैयार होने पर आप उन्हें फिर से प्रकाशित करते हैं।

अनुरोध और जवाब कैसे दिखते हैं?

हर एंडपॉइंट https://monstarx.com/api/rest/<your project id> के नीचे होता है, उसके बाद उसका पथ।

सूची

curl 'https://monstarx.com/api/rest/<project id>/recipes?page=1&limit=25'

{
  "data": [
    { "id": "41a6…", "title": "Street tacos al pastor", "country_code": "MX" }
  ],
  "page": 1,
  "limit": 25,
  "hasMore": false
}

limit हर पेज में 1 से 100 रिकॉर्ड है (न दें तो 25), और page 1 से 100 तक। hasMore बताता है कि अगला पेज है या नहीं।

बनाना

curl -X POST 'https://monstarx.com/api/rest/<project id>/recipes' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Lemon ricotta pancakes", "country_code": "IT"}'

जवाब (स्थिति 201) में नया रिकॉर्ड data के नीचे होता है, साथ में उसकी id।

अपडेट और हटाना

curl -X PATCH 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Fluffy lemon ricotta pancakes"}'

curl -X DELETE 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY'

अपडेट करें बदला हुआ रिकॉर्ड लौटाता है; हटाएँ { "deleted": true } लौटाता है।

आप जो भेजते हैं, उसके नियम:

• Content-Type: application/json के साथ एक JSON ऑब्जेक्ट, 64 KB तक।
• सिर्फ़ उपलब्ध कराए गए फ़ील्ड, हर एक एक सादी वैल्यू: टेक्स्ट (20,000 अक्षरों तक), नंबर, true/false या null।
• id न सेट की जा सकती है न बदली जा सकती है, और न ही वे फ़ील्ड जो एडमिन में केवल पढ़ने के लिए हैं।

कुछ गलत होने पर जवाब में एक error संदेश और एक स्थिति होती है: 400 (अनुरोध सही नहीं है), 401 (एक मान्य प्रोजेक्ट API कुंजी चाहिए), 403 (एडमिन में वह टेबल या काम अनुमति में नहीं है), 404 (ऐसा कोई एंडपॉइंट या रिकॉर्ड नहीं), 409 (टकराव, जैसे डुप्लिकेट), 413 (जवाब 1 MB से बड़ा हो जाएगा — कम फ़ील्ड उपलब्ध कराएँ या छोटा पेज इस्तेमाल करें)।

अक्सर पूछे जाने वाले सवाल

मैं “डॉक्स प्रकाशित करें” पर क्लिक क्यों नहीं कर पा रहा?

डॉक्स के लिए कम से कम एक लाइव एंडपॉइंट चाहिए और कोई बिना सेव किया बदलाव नहीं होना चाहिए। किसी एंडपॉइंट पर एंडपॉइंट प्रकाशित करें पर टिक लगाएँ, एंडपॉइंट सहेजें और प्रकाशित करें पर क्लिक करें, फिर डॉक्स प्रकाशित करें पर।

क्या API काम करे, इसके लिए मुझे अपना ऐप प्रकाशित करना होगा?

नहीं। API आपके प्रोजेक्ट के डेटाबेस को सीधे पढ़ता और लिखता है, इसलिए कोई एंडपॉइंट प्रकाशित होते ही वह काम करने लगता है। यह वही डेटा इस्तेमाल करता है जो आपका प्रीव्यू और लाइव ऐप करते हैं, और इसके लिए न कोई बिल्ड चाहिए, न AI, न क्रेडिट।

क्या कोई वेबसाइट ब्राउज़र से मेरा API कॉल कर सकती है?

हाँ, कोई भी वेबसाइट आपके एंडपॉइंट कॉल कर सकती है। वेब पेजों से सार्वजनिक पढ़ने की अनुमति वाले एंडपॉइंट इस्तेमाल करें, और कुंजी वाली कॉल सर्वर पर रखें, ताकि कुंजी गुप्त रहे।

मेरी API कुंजी खो गई। क्या मैं उसे फिर से देख सकता हूँ?

नहीं, कुंजी सिर्फ़ एक बार दिखाई जाती है। नई कुंजी बनाएँ, सेवा को उस पर ले जाएँ, फिर पुरानी कुंजी को रद्द करें।

मैं कोई एंडपॉइंट प्रकाशित क्यों नहीं कर पा रहा?

बनाएँ, अपडेट करें या हटाएँ के लिए पहले एडमिन में उस टेबल के लिए वह काम चालू करें। जिस ऐप का लाइव डेटाबेस आपके अपने Cloudflare खाते पर चलता है, वह MonstarX से एंडपॉइंट प्रकाशित नहीं कर सकता, क्योंकि यहाँ का डेटाबेस प्रीव्यू का अभ्यास-डेटा रखता है।

क्या डेटा बदलने पर मुझे वेबहुक मिल सकते हैं?

एडमिन → API से नहीं, क्योंकि वह सिर्फ़ अनुरोधों का जवाब देता है। MonstarX से अपने ऐप में वेबहुक जोड़ने को कहें — जैसे “कोई ऑर्डर आने पर उसे इस पते पर POST करें”।

संबंधित

आपके ऐप का एडमिन पैनलजहाँ API रहते हैं, आपकी टेबल, उपयोगकर्ताओं और गतिविधि के साथ।

आपके ऐप का डेटाबेसवे टेबल जिन्हें आपके एंडपॉइंट पढ़ते और लिखते हैं।

सीक्रेट और API कुंजियाँवे कुंजियाँ जो आपका ऐप दूसरी सेवाओं के लिए इस्तेमाल करता है।

अपने कोडिंग एजेंट से MonstarX इस्तेमाल करेंClaude Code, Cursor और दूसरों से खुद MonstarX चलाएँ।