मदद केंद्र / डेवलपर के लिए

ऐप बनाइए

OAuth ऐप रजिस्टर करें, व्यापारियों को ज़रूरी पहुँच के साथ इंस्टॉल करने दें, API और वेबहुक इस्तेमाल करें, और मार्केटप्लेस में लिस्ट करें।

BazaarSaaS ऐप आपकी अपनी वेब सर्विस है जो उसे इंस्टॉल करने वाले स्टोरों के साथ काम करती है — जैसे अकाउंटिंग एक्सपोर्ट, WhatsApp मार्केटिंग टूल, रिव्यू इम्पोर्टर या वेयरहाउस सिंक। यह आपके सर्वर पर चलती है और हर स्टोर से public API और वेबहुक से बात करती है, उस token के साथ जो व्यापारी इंस्टॉल करते समय देता है।

1. काम करने के लिए एक स्टोर लें

स्टोर बनाएँ — मुफ़्त है। अपना ऐप आप इसी के एडमिन से रजिस्टर करते हैं, और यही आपका टेस्ट स्टोर भी है।

2. ऐप रजिस्टर करें

एडमिन → ऐप्स → ऐप का नाम और अपना redirect URI डालें (मंज़ूरी के बाद व्यापारी जहाँ लौटते हैं, जैसे https://myapp.example.com/bazaarsaas/callback)। आपको client id और client secret मिलता है — secret सिर्फ़ एक बार दिखता है; उसे अपने सर्वर पर सुरक्षित रखें।

3. सिर्फ़ उतनी पहुँच माँगें जितनी चाहिए (scopes)

Scope व्यापारी को क्या दिखता है
products:read आपके प्रोडक्ट, क़ीमत और स्टॉक देखना
products:write आपके प्रोडक्ट, क़ीमत और स्टॉक जोड़ना और बदलना
orders:read आपके ऑर्डर देखना, ख़रीदारों के नाम, फ़ोन नंबर और पते समेत
webhooks:write ऑर्डर पक्के होने या भेजे जाने पर सूचना पाना (वेबहुक)

4. इंस्टॉल (OAuth) का तरीक़ा

  1. व्यापारी को उसके स्टोर के सहमति पेज पर भेजें (उसे अपने एडमिन में लॉग-इन होना चाहिए):

    https://<store-address>/oauth/authorize?clientId=<client id>&redirectUri=<your redirect URI>&scope=products:read%20orders:read&state=<random>
    
  2. उसे आसान शब्दों में "आपका ऐप इंस्टॉल करें? यह कर सकेगा: …" दिखता है और वह मंज़ूर करता है।

  3. BazaarSaaS उसे ?code=…&state=… के साथ आपके redirect URI पर भेजता है। जाँचें कि state वही है जो आपने भेजा था।

  4. अपने सर्वर से code के बदले token लें:

    curl -X POST https://<store-address>/oauth/token \
      -d grant_type=authorization_code -d client_id=<client id> -d client_secret=<secret> \
      -d code=<code> -d redirect_uri=<your redirect URI>
    

    → { "access_token": "bzoauth_…", "token_type": "Bearer", "scope": "products:read orders:read" }

हर स्टोर का token अलग रखें; यह सिर्फ़ उन्हीं scopes के लिए चलता है जो व्यापारी ने मंज़ूर किए।

5. API और वेबहुक इस्तेमाल करें

स्टोर के पते पर Authorization: Bearer bzoauth_… के साथ /api/public/… बुलाएँ — endpoints API और वेबहुक में हैं। webhooks:write होने पर order.confirmed और order.shipped पाने के लिए POST /api/public/webhooks से अपना endpoint रजिस्टर करें; इन पर X-BazaarSaaS-Signature से हस्ताक्षर होता है।

6. जब व्यापारी ऐप हटाता है

ऐप का token चलना बंद हो जाता है, उसके वेबहुक बंद हो जाते हैं, और आपको आख़िरी app.uninstalled वेबहुक मिलता है — उस स्टोर का जो डेटा अब नहीं चाहिए, उसे मिटा दें।

7. मार्केटप्लेस में लिस्ट करें

एडमिन → ऐप्स → आपका ऐप → List in marketplace: नाम, कैटेगरी, सारांश, ब्योरा, स्क्रीनशॉट लिंक, ज़रूरी scopes, क़ीमत (मुफ़्त, एक बार या मासिक, चाहें तो ट्रायल के दिनों के साथ), डेवलपर का नाम और सपोर्ट ईमेल।

भेजने पर यह BazaarSaaS टीम के पास जाता है, जो उसे पढ़ती है, ठीक उन्हीं scopes के साथ टेस्ट-इंस्टॉल करती है और कारण के साथ मंज़ूर या नामंज़ूर करती है। मंज़ूर ऐप हर स्टोर के मार्केटप्लेस में दिखते हैं; लिस्टिंग में बाद का हर बदलाव फिर से जाँचा जाता है (जिन स्टोरों ने पहले से इंस्टॉल किया है, उनके पास तब तक ऐप रहता है)। पेड ऐप व्यापारी के BazaarSaaS बिल पर चार्ज होते हैं — मासिक ऐप ट्रायल के बाद सिर्फ़ पूरे महीनों के लिए, और हटाने के बाद कभी नहीं।

भेजने से पहले की चेकलिस्ट

  • सबसे कम scopes माँगें; लिस्टिंग में बताएँ कि हर एक क्यों चाहिए।
  • वेबहुक के हस्ताक्षर और OAuth का state जाँचें।
  • app.uninstalled संभालें, और secrets व tokens सिर्फ़ अपने सर्वर पर रखें।
  • व्यापारियों को ऐसा सपोर्ट ईमेल दें जिस पर जवाब आए।

फिर भी अटके? हमसे बात करें — हम सेट करने में मदद करेंगे। हमसे बात करें