गाइड

Nubbo API के साथ शुरुआत करें

शून्य से अपने पहले अनुरोध तक कुछ ही मिनटों में। एक कुंजी बनाएँ और अपने कोड से अपना स्टोरेज मैनेज करना शुरू करें।

Nubbo API एक REST API है जिससे आप अपने कोड से अपने बकेट के साथ काम कर सकते हैं: फ़ाइलें, फ़ोल्डर, लिंक, फ़ाइल अनुरोध, गैलरी, लेबल, प्रोजेक्ट और ऑटोमेशन। इस गाइड में आप एक कुंजी बनाते हैं और curl से अपने पहले अनुरोध भेजते हैं।

आपको क्या मिलता है

  • अपने प्रोग्राम से अपना Nubbo स्पेस मैनेज करें, ऐसी कुंजियों के साथ जो केवल वही देखती हैं जो आप चुनते हैं।
  • अपने कोड और अपने स्टोरेज प्रोवाइडर के बीच सीधे अपलोड और डाउनलोड करें।
  • ट्रिगर के ज़रिए नई फ़ाइलों, फ़ाइल अनुरोध में अपलोड और गतिविधि पर प्रतिक्रिया दें।

शुरू करने से पहले

आपको Pro या टीमें प्लान वाला Nubbo खाता और curl वाला एक टर्मिनल चाहिए। टीम में API कुंजियां मालिक या कोई एडमिन बनाते हैं।

चरण 1: कुंजी बनाएँ

  1. Nubbo में सेटिंग्स › API खोलें (या टीम में टीम › API) और API कुंजी बनाएं दबाएँ।

  2. एक नाम दें और चुनें:

    • एक्सेस: केवल पढ़ना या पढ़ना और लिखना।
    • दायरा: पूरा स्पेस या चुने गए बकेट और प्रोजेक्ट। कुंजी केवल वही देखती है जो आप यहां चुनते हैं।
    • समाप्ति: 30 दिन, 90 दिन, 1 वर्ष या कोई समाप्ति नहीं। Nubbo आपको 7 दिन पहले सूचना देता है।

    कुंजी बनाएं दबाएँ। Nubbo पुष्टि के लिए आपका पासवर्ड माँगता है कि यह आप ही हैं। अगर दो-चरणीय सत्यापन चालू है, तो यह कोड भी माँगता है।

    एक्सेस, दायरा और समाप्ति के साथ API कुंजी बनाएं विंडो एक्सेस, दायरा और समाप्ति के साथ API कुंजी बनाएं विंडो
  3. कुंजी कॉपी करें और मैंने इसे सहेज लिया है दबाएँ। यह nbk_ से शुरू होती है और यही एकमात्र बार है जब आप इसे पूरा देखेंगे। इसे सर्वर पर या उस टूल में रखें जो इसे इस्तेमाल करेगा, कभी किसी वेब पेज में नहीं।

    आपकी API कुंजी विंडो, कॉपी करने के लिए तैयार कुंजी के साथ आपकी API कुंजी विंडो, कॉपी करने के लिए तैयार कुंजी के साथ

चरण 2: आपका पहला अनुरोध

हर अनुरोध के Authorization हेडर में कुंजी भेजें। GET /v1/me से शुरू करें, जिसमें कोई अनुरोध खर्च नहीं होता:

curl https://api.nubbo.app/v1/me \
  -H "Authorization: Bearer nbk_your_key"

जवाब में आपका स्पेस, आपका प्लान, महीने का कोटा और कुंजी उसके एक्सेस और दायरे के साथ आती है। यह एक अंश है:

{
  "workspace": { "id": "…", "name": "नॉर्थ स्टूडियो", "kind": "PERSONAL" },
  "plan": "PRO",
  "key": {
    "name": "मेरी पहली कुंजी",
    "prefix": "nbk_3jKF3m",
    "access": "READ",
    "allResources": true
  },
  "quota": {
    "requests": { "used": 0, "limit": 50000, "remaining": 50000 },
    "events": { "used": 0, "limit": 20000, "remaining": 20000 },
    "ratePerMinute": 60
  }
}

इसके बाद अपने बकेट और किसी फ़ोल्डर की फ़ाइलों की सूची देखें:

curl https://api.nubbo.app/v1/buckets \
  -H "Authorization: Bearer nbk_your_key"

curl "https://api.nubbo.app/v1/buckets/<bucketId>/files?prefix=invoices/" \
  -H "Authorization: Bearer nbk_your_key"

सूचियाँ data और nextCursor लौटाती हैं। अगले पेज के लिए वह मान cursor में भेजें। जब nextCursor का मान null हो, तो और कुछ नहीं है।

GET /v1/me अनुरोध और उसके जवाब के साथ टर्मिनल GET /v1/me अनुरोध और उसके जवाब के साथ टर्मिनल

चरण 3: रेफ़रेंस

सेटिंग्स › API में दस्तावेज़ देखें दबाएँ, या api.nubbo.app/v1/docs खोलें। वहाँ हर रिसोर्स अपने फ़ील्ड और उदाहरणों के साथ है। OpenAPI दस्तावेज़ api.nubbo.app/v1/openapi.json पर है।

curl उदाहरण के साथ Nubbo API रेफ़रेंस curl उदाहरण के साथ Nubbo API रेफ़रेंस

अपलोड और डाउनलोड

फ़ाइलें Nubbo से होकर नहीं गुज़रतीं। कोई फ़ाइल अपलोड करने के लिए POST /v1/buckets/{bucketId}/uploads से अपलोड माँगें, फ़ाइल को लौटाए गए presigned पते पर भेजें और POST /v1/uploads/{uploadId}/complete से पूरा करें। डाउनलोड करने के लिए POST /v1/files/{fileId}/download-link से एक लिंक माँगें और उसे अपने प्रोवाइडर से डाउनलोड करें।

सीमाएँ

Proटीमें
प्रति कुंजी प्रति मिनट अनुरोध60120
प्रति माह अनुरोध50,000100,000 + 10,000 प्रति सीट
प्रति माह ट्रिगर इवेंट20,00050,000 + 5,000 प्रति सीट

कोटा स्पेस का होता है और हर बिलिंग अवधि के साथ नवीनीकृत होता है। GET /v1/me, ट्रिगर की जाँचें और 401, 429 और 5xx जवाब अनुरोध के रूप में नहीं गिने जाते। ट्रिगर से डिलीवर हर इवेंट एक इवेंट के रूप में गिना जाता है। हर जवाब में X-RateLimit-Remaining और X-Nubbo-Quota-Requests-Remaining हेडर आते हैं, और सेटिंग्स › API में आप अवधि का उपयोग देख सकते हैं।

Nubbo सेटिंग्स में अवधि का API उपयोग Nubbo सेटिंग्स में अवधि का API उपयोग

अगर कुछ गड़बड़ हो

  • API_KEY_INVALID, API_KEY_REVOKED या API_KEY_EXPIRED: कुंजी अमान्य है, रद्द हो चुकी है या समाप्त हो गई है। हेडर जाँचें या नई कुंजी बनाएँ।
  • API_PLAN_REQUIRED: कुंजी के स्पेस में API नहीं है। यह Pro और टीमें प्लान में है।
  • API_KEY_READ_ONLY: कुंजी केवल पढ़ने वाली है। पढ़ना और लिखना वाली कुंजी बनाएँ।
  • API_RATE_LIMITED: इस कुंजी से बहुत ज़्यादा अनुरोध। Retry-After के सेकंड इंतज़ार करें और फिर से कोशिश करें।
  • API_QUOTA_EXCEEDED: स्पेस ने इस महीने की अपनी सीमा इस्तेमाल कर ली है। details.resetsAt बताता है कि यह कब नवीनीकृत होगा।

हर त्रुटि में एक requestId होता है। अगर आप हमें लिखें तो उसे शामिल करें।

Nubbo API के बारे में और जानें। बिना कोड लिखे इसे इस्तेमाल करने के लिए Zapier, n8n या Make की गाइड देखें। अपने AI असिस्टेंट से इसे इस्तेमाल करने के लिए देखें कि Nubbo को Claude, ChatGPT या Cursor से कैसे जोड़ें।

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

किन प्लान में API शामिल है?

Pro और टीमें। निःशुल्क या Personal के साथ अनुरोधों का जवाब API_PLAN_REQUIRED होता है।

क्या मैं API से एन्क्रिप्ट की गई फ़ाइलें पढ़ सकता हूँ?

नहीं। एन्क्रिप्ट की गई चीज़ें बिना नाम, पाथ, आकार या प्रकार के दिखती हैं और उन पर किया गया कोई भी बदलाव API_ENCRYPTED_CONTENT के साथ अस्वीकार हो जाता है।

अगर नेटवर्क की गड़बड़ी से मैं कोई अनुरोध दोहराऊँ तो क्या होगा?

अपने POST और PATCH में Idempotency-Key हेडर भेजें। 24 घंटे तक वही अनुरोध दोहराने पर पहला जवाब मिलता है और कुछ भी दो बार नहीं बनता।

क्या API बिना बताए बदलेगा?

नहीं। कुछ तोड़ने वाला बदलाव /v2 के रूप में आता है और /v1 कम से कम 12 महीने तक बना रहता है, Deprecation और Sunset हेडर के साथ।

स्रोत

चरण इन पेजों से जाँचे गए हैं।