अनुरोधों को अनुमति देना

Search Console API के लिए, पुष्टि करने से जुड़ी ज़रूरी शर्तें

आपका ऐप्लिकेशन, Google Search Console API को जो भी अनुरोध भेजता है उसमें अनुमति वाला टोकन शामिल होना चाहिए. इस टोकन से Google आपके ऐप्लिकेशन की पहचान भी करता है.

अनुमति देने के प्रोटोकॉल के बारे में जानकारी

अनुरोधों को अनुमति देने के लिए, आपके ऐप्लिकेशन में OAuth 2.0 का इस्तेमाल किया जाना चाहिए. अनुमति देने वाले दूसरे प्रोटोकॉल इस्तेमाल नहीं किए जा सकते. अगर आपका ऐप्लिकेशन Google से साइन इन करने की सुविधा इस्तेमाल करता है, तो अनुमति देने से जुड़े कुछ पहलुओं को Google आपके लिए खुद मैनेज करता है.

OAuth 2.0 से अनुरोधों को अनुमति देना

Google Search Console API को भेजे जाने वाले सभी अनुरोधों की अनुमति, किसी ऐसे उपयोगकर्ता को दी जानी चाहिए जिसके पास ऐसा करने का अधिकार हो.

OAuth 2.0 के लिए अनुमति देने की प्रक्रिया या "तरीका" अलग-अलग हो सकता है. यह इस बात पर निर्भर करता है कि ऐप्लिकेशन किस तरह का है. सभी तरह के ऐप्लिकेशन के लिए नीचे दी गई सामान्य प्रक्रिया लागू होती है:

  1. ऐप्लिकेशन बनाने के बाद, उसे Google API (एपीआई) कंसोल का इस्तेमाल करके, रजिस्टर किया जाता है. इसके बाद, Google आपको क्लाइंट आईडी और क्लाइंट सीक्रेट जैसी जानकारी देगा. इस जानकारी की ज़रूरत आपको बाद में पड़ेगी.
  2. Google API कंसोल में Google Search Console API को चालू करें. (अगर एपीआई को 'API कंसोल' की सूची में नहीं जोड़ा गया है, तो यह चरण छोड़ दें.)
  3. जब आपके ऐप्लिकेशन को उपयोगकर्ता के डेटा को ऐक्सेस करने की ज़रूरत होती है, तब वह Google से, डेटा के खास लिंक का अनुरोध करता है.
  4. Google, उपयोगकर्ता को सहमति वाली स्क्रीन दिखाता है, जिसमें उनसे आपके ऐप्लिकेशन को उनके कुछ डेटा को ऐक्सेस करने की अनुमति मांगी जाती है.
  5. अगर उपयोगकर्ता इसकी अनुमति दे देता है, तो Google आपके ऐप्लिकेशन को कुछ समय के लिए इस्तेमाल किए जा सकने वाला ऐक्सेस टोकन देता है.
  6. आपका ऐप्लिकेशन, ऐक्सेस टोकन से उपयोगकर्ता के डेटा को ऐक्सेस करने का अनुरोध करता है.
  7. अगर Google को पता चलता है कि आपका अनुरोध और टोकन मान्य है, तो वह आपके ऐप्लिकेशन को अनुरोध किए गए डेटा का ऐक्सेस दे देता है.

कुछ तरीकों में दूसरे चरण भी शामिल हो सकते हैं, जैसे कि रिफ़्रेश टोकन इस्तेमाल करके, नया ऐक्सेस टोकन पाना. अलग-अलग तरह के ऐप्लिकेशन के लिए डेटा ऐक्सेस करने के तरीकों के बारे में ज़्यादा जानकारी पाने के लिए, Google का OAuth 2.0 दस्तावेज़ पढ़ें.

यहां Google Search Console API के लिए, OAuth 2.0 के दायरे की जानकारी दी गई है:

स्कोप लिंक
https://www.googleapis.com/auth/webmasters पढ़ने/लिखने का एक्सेस
https://www.googleapis.com/auth/webmasters.readonly सिर्फ़ पढ़ने का एक्सेस

OAuth 2.0 का इस्तेमाल करके डेटा एक्सेस करने का अनुरोध करने के लिए, आपके ऐप्लिकेशन को अनुरोध के तरीके की जानकारी देनी होगी. साथ ही, वह जानकारी भी देनी होगी, जो आपको ऐप्लिकेशन रजिस्टर करते समय Google से मिली थी (जैसे, क्लाइंट आईडी और क्लाइंट सीक्रेट).

सलाह: Google API की क्लाइंट लाइब्रेरी आपके लिए अनुमति देने की कुछ प्रक्रियाएं खुद कर सकती है. ये लाइब्रेरी कई प्रोग्रामिंग भाषाओं के लिए उपलब्ध होती हैं. ज़्यादा जानकारी के लिए लाइब्रेरी और नमूनों वाला पेज देखें.

Search Console टेस्टिंग टूल एपीआई के लिए, पुष्टि करने से जुड़ी ज़रूरी शर्तें

एपीआई पासकोड हासिल करना और उसका इस्तेमाल करना

सार्वजनिक डेटा के लिए, Search Console टेस्टिंग टूल एपीआई को भेजे जाने वाले अनुरोधों के साथ कोई आइडेंटिफ़ायर ज़रूर होना चाहिए. यह आइडेंटिफ़ायर, एपीआई पासकोड या ऐक्सेस टोकन हो सकता है.

एपीआई पासकोड हासिल करने के लिए:

  1. API कंसोल में क्रेडेंशियल पेज खोलें.
  2. यह एपीआई दो तरह के क्रेडेंशियल के साथ काम करता है. अपने प्रोजेक्ट के लिए सही क्रेडेंशियल बनाएं:

    • OAuth 2.0: जब भी आपका ऐप्लिकेशन, उपयोगकर्ता के निजी डेटा का अनुरोध करता है, तो उसे अनुरोध के साथ OAuth 2.0 टोकन भेजना चाहिए. आपका ऐप्लिकेशन, टोकन पाने के लिए सबसे पहले एक क्लाइंट आईडी भेजता है. हो सकता है, यह क्लाइंट सीक्रेट भी भेजा जा सकता है. वेब ऐप्लिकेशन, सेवा खातों या इंस्टॉल किए गए ऐप्लिकेशन के लिए, OAuth 2.0 क्रेडेंशियल जनरेट किए जा सकते हैं.

      ज़्यादा जानकारी के लिए, OAuth 2.0 दस्तावेज़ देखें.

    • एपीआई पासकोड: OAuth 2.0 टोकन उपलब्ध न कराने वाले अनुरोध के लिए, एपीआई पासकोड भेजना ज़रूरी है. यह कुंजी आपके प्रोजेक्ट की पहचान करती है. साथ ही, एपीआई ऐक्सेस, कोटा, और रिपोर्ट उपलब्ध कराती है.

      एपीआई, एपीआई पासकोड पर कई तरह की पाबंदियों के साथ काम करता है. अगर आपको जिस एपीआई पासकोड की ज़रूरत है वह पहले से मौजूद नहीं है, तो Console में एपीआई पासकोड बनाएं. इसके लिए, क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें. कुंजी को प्रोडक्शन में इस्तेमाल करने से पहले उसे सीमित किया जा सकता है. इसके लिए, कुंजी पर पाबंदी लगाएं पर क्लिक करें और पाबंदियां में से कोई एक चुनें.

अपनी एपीआई कुंजियों को सुरक्षित रखने के लिए, एपीआई पासकोड का इस्तेमाल सुरक्षित तरीके से करने के सबसे सही तरीके अपनाएं.

एपीआई पासकोड मिलने के बाद, आपका ऐप्लिकेशन, अनुरोध किए गए सभी यूआरएल में क्वेरी पैरामीटर key=yourAPIKey को जोड़ सकता है.

एपीआई पासकोड, यूआरएल में एम्बेड करने के लिए सुरक्षित होता है. इसे कोड में बदलने की कोई ज़रूरत नहीं होती.