इस गाइड में बताया गया है कि दूसरे पक्षों के व्यापारी खातों का ऐक्सेस पाने का अनुरोध करने के लिए, OAuth 2.0 का इस्तेमाल कैसे किया जा सकता है. अगर आप सेवा देने वाली तीसरे पक्ष की कंपनी हैं, तो अपने ऐप्लिकेशन को क्लाइंट के व्यापारी खातों का ऐक्सेस मांगने की अनुमति देने के लिए, इस वर्कफ़्लो का इस्तेमाल करें.
अगर आपको कोई ऐसा इन-हाउस ऐप्लिकेशन बनाना है जिसे सिर्फ़ आपके कारोबारी खाते का ऐक्सेस चाहिए, तो अपना खाता ऐक्सेस करना लेख पढ़ें.
ऐप्लिकेशन की पुष्टि का अनुरोध करना
Merchant API को ऐक्सेस करने वाले ऐप्लिकेशन को, OAuth की पुष्टि की समीक्षा की प्रक्रिया से गुज़रना होगा. बिना पुष्टि वाले ऐप्लिकेशन को चेतावनियां मिलेंगी और उनकी कुछ सुविधाएं काम करेंगी.
Google Cloud में ऐप्लिकेशन का मतलब है यूनीक OAuth 2.0 Client-ID.
आम तौर पर, पुष्टि की प्रक्रिया में तीन से पांच कामकाजी दिन लगते हैं. ज़्यादा जानने और पुष्टि का अनुरोध सबमिट करने के लिए, ऐप्लिकेशन के लिए पुष्टि करना देखें.
यह नीति सभी ऐप्लिकेशन पर लागू होती है. हमारा सुझाव है कि आप सभी ऐप्लिकेशन की पुष्टि जल्द से जल्द कर लें, ताकि कारोबार में कोई रुकावट न आए.
OAuth स्कोप पाएं
दायरे को चुनने से जुड़ी समस्याओं से बचने के लिए, इंक्रीमेंटल अनुमति सेट अप करें.
अगर ऐप्लिकेशन के लिए सहमति वाली स्क्रीन पर, OAuth के सभी स्कोप डिफ़ॉल्ट रूप से नहीं चुने जाते हैं, तो एक से ज़्यादा अनुरोध करने पर ये स्कोप के तौर पर दिखते हैं. जब आपका ऐप्लिकेशन किसी उपयोगकर्ता को सहमति वाली स्क्रीन दिखाता है, तो उपयोगकर्ता को ऐक्सेस की अनुमति देने के लिए हर दायरे को मैन्युअल रूप से चुनना होता है.
OAuth के अनुरोध से मिला रिस्पॉन्स देखें, ताकि यह पुष्टि की जा सके कि आपके ऐप्लिकेशन को सही दायरे मिले हैं या नहीं.
ज़्यादा जानकारी के लिए, OAuth 2.0 की नीतियां देखें.
अनुरोधों को अनुमति दें
आपका ऐप्लिकेशन, Merchant API को भेजे जाने वाले हर अनुरोध में, अनुमति वाला टोकन शामिल होना चाहिए. इस टोकन से Google आपके ऐप्लिकेशन की पहचान भी करता है.
अनुमति देने के प्रोटोकॉल के बारे में जानकारी
अनुरोधों को अनुमति देने के लिए, आपके ऐप्लिकेशन में OAuth 2.0 का इस्तेमाल किया जाना चाहिए. अनुमति देने वाले दूसरे प्रोटोकॉल इस्तेमाल नहीं किए जा सकते. अगर आपका ऐप्लिकेशन Google से साइन इन करने की सुविधा इस्तेमाल करता है, तो अनुमति देने से जुड़े कुछ पहलुओं को Google आपके लिए खुद मैनेज करता है.
OAuth 2.0 से अनुरोधों को अनुमति देना
व्यापारी/कंपनी/कारोबारी के एपीआई को किए जाने वाले सभी अनुरोधों की पुष्टि, किसी ऐसे उपयोगकर्ता को करनी चाहिए जिसके पास ऐसा करने का अधिकार हो.
OAuth 2.0 के लिए अनुमति देने की प्रक्रिया या "तरीका" अलग-अलग हो सकता है. यह इस बात पर निर्भर करता है कि ऐप्लिकेशन किस तरह का है. सभी तरह के ऐप्लिकेशन के लिए नीचे दी गई सामान्य प्रक्रिया लागू होती है:
- ऐप्लिकेशन बनाने के बाद, उसे Google API (एपीआई) कंसोल का इस्तेमाल करके, रजिस्टर किया जाता है. इसके बाद, Google आपको क्लाइंट आईडी और क्लाइंट सीक्रेट जैसी जानकारी देगा. इस जानकारी की ज़रूरत आपको बाद में पड़ेगी.
- Google API (एपीआई) कंसोल में जाकर Merchant API को चालू करें. (अगर एपीआई को 'API कंसोल' की सूची में नहीं जोड़ा गया है, तो यह चरण छोड़ दें.)
- जब आपके ऐप्लिकेशन को उपयोगकर्ता के डेटा को ऐक्सेस करने की ज़रूरत होती है, तब वह Google से, डेटा के खास लिंक का अनुरोध करता है.
- Google, उपयोगकर्ता को सहमति वाली स्क्रीन दिखाता है, जिसमें उनसे आपके ऐप्लिकेशन को उनके कुछ डेटा को ऐक्सेस करने की अनुमति मांगी जाती है.
- अगर उपयोगकर्ता इसकी अनुमति दे देता है, तो Google आपके ऐप्लिकेशन को कुछ समय के लिए इस्तेमाल किए जा सकने वाला ऐक्सेस टोकन देता है.
- आपका ऐप्लिकेशन, ऐक्सेस टोकन से उपयोगकर्ता के डेटा को ऐक्सेस करने का अनुरोध करता है.
- अगर Google को पता चलता है कि आपका अनुरोध और टोकन मान्य है, तो वह आपके ऐप्लिकेशन को अनुरोध किए गए डेटा का ऐक्सेस दे देता है.
कुछ तरीकों में दूसरे चरण भी शामिल हो सकते हैं, जैसे कि रिफ़्रेश टोकन इस्तेमाल करके, नया ऐक्सेस टोकन पाना. अलग-अलग तरह के ऐप्लिकेशन के लिए डेटा ऐक्सेस करने के तरीकों के बारे में ज़्यादा जानकारी पाने के लिए, Google का OAuth 2.0 दस्तावेज़ पढ़ें.
यहां व्यापारी/कंपनी के एपीआई के लिए, OAuth 2.0 के दायरे की जानकारी दी गई है:
स्कोप | लिंक |
---|---|
https://www.googleapis.com/auth/content |
पढ़ने/लिखने का ऐक्सेस. |
OAuth 2.0 का इस्तेमाल करके, डेटा ऐक्सेस करने का अनुरोध करने के लिए, आपके ऐप्लिकेशन को अनुरोध के तरीके की जानकारी देनी होगी. साथ ही, वह जानकारी भी देनी होगी जो आपको ऐप्लिकेशन रजिस्टर करते समय, Google से मिली थी, जैसे कि क्लाइंट आईडी और क्लाइंट सीक्रेट.
यह एक सैंपल है. इसे अनुमति देने के लिए इस्तेमाल किया जा सकता है.