OAuth का इस्तेमाल करें

पते की पुष्टि करने वाला एपीआई, पुष्टि करने के लिए OAuth 2.0 का इस्तेमाल करता है. Google, OAuth 2.0 के सामान्य मामलों पर काम करता है. जैसे, वेब सर्वर के लिए.

इस दस्तावेज़ में, आपके डेवलपमेंट एनवायरमेंट में पते की पुष्टि करने वाले एपीआई कॉल में OAuth टोकन को पास करने का तरीका बताया गया है. प्रोडक्शन एनवायरमेंट में OAuth का इस्तेमाल करने के बारे में जानकारी पाने के लिए, Google में पुष्टि करने की सुविधा देखें.

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

पते की पुष्टि करने वाले एपीआई का इस्तेमाल शुरू करने से पहले, आपको ऐसा प्रोजेक्ट चाहिए जिसमें बिलिंग खाते हो और पते की पुष्टि करने वाला एपीआई चालू हो. हम एक से ज़्यादा प्रोजेक्ट के मालिक और बिलिंग एडमिन बनाने का सुझाव देते हैं, ताकि आपकी टीम के लिए इन भूमिकाओं के लिए हमेशा कोई न कोई उपलब्ध रहे. ज़्यादा जानने के लिए, Cloud Console में सेट अप करें देखें.

OAuth के बारे में जानकारी

अपने डिप्लॉयमेंट के आधार पर OAuth का इस्तेमाल करके, ऐक्सेस टोकन बनाने और उन्हें मैनेज करने के कई तरीके हैं.

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

इसके अलावा, Android या iOS मोबाइल ऐप्लिकेशन में पते की पुष्टि करने वाले एपीआई का इस्तेमाल किया जा सकता है. पते की पुष्टि करने वाले एपीआई के साथ OAuth का इस्तेमाल करने के बारे में सामान्य जानकारी पाने के लिए, अलग-अलग डिप्लॉयमेंट एनवायरमेंट के लिए ऐक्सेस टोकन मैनेज करने के बारे में जानने के लिए, Google API को ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना देखें.

OAuth स्कोप के बारे में जानकारी

पते की पुष्टि करने वाले एपीआई के साथ OAuth का इस्तेमाल करने के लिए, OAuth टोकन को स्कोप असाइन करना ज़रूरी है:

  • https://www.googleapis.com/auth/cloud-platform

उदाहरण: अपने लोकल डेवलपमेंट एनवायरमेंट में REST API कॉल आज़माएं

अगर आपको OAuth टोकन का इस्तेमाल करके पते की पुष्टि करने वाला एपीआई आज़माना है, लेकिन टोकन जनरेट करने के लिए एनवायरमेंट सेटअप की सुविधा नहीं है, तो कॉल करने के लिए इस सेक्शन में दिया गया तरीका इस्तेमाल करें.

इस उदाहरण में, कॉल करने के लिए ऐप्लिकेशन डिफ़ॉल्ट क्रेडेंशियल (ADC) से मिले OAuth टोकन का इस्तेमाल करने का तरीका बताया गया है. क्लाइंट लाइब्रेरी की मदद से Google API को कॉल करने के लिए ADC का इस्तेमाल करने के बारे में जानकारी के लिए, क्लाइंट लाइब्रेरी का इस्तेमाल करके पुष्टि करें देखें.

ज़रूरी शर्तें

ADC का इस्तेमाल करके REST का अनुरोध करने से पहले, ADC को क्रेडेंशियल देने के लिए Google क्लाउड सीएलआई का इस्तेमाल करें:

  1. अगर आपने अभी तक कोई प्रोजेक्ट नहीं बनाया है, तो Google Cloud Console में सेट अप करें में दिया गया तरीका अपनाकर प्रोजेक्ट बनाएं और बिलिंग चालू करें.
  2. gcloud सीएलआई को इंस्टॉल करके शुरू करें.

  3. अपनी क्रेडेंशियल फ़ाइल बनाने के लिए, अपने कंप्यूटर पर नीचे दिए गए gcloud निर्देश को चलाएं:

    gcloud auth application-default login
  4. आपको एक लॉगिन स्क्रीन दिखेगी. लॉग इन करने के बाद, आपके क्रेडेंशियल ADC की इस्तेमाल की जाने वाली लोकल क्रेडेंशियल फ़ाइल में सेव किए जाते हैं.

ज़्यादा जानकारी के लिए, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल के लिए क्रेडेंशियल दें दस्तावेज़ का लोकल डेवलपमेंट एनवायरमेंट सेक्शन देखें.

REST के लिए अनुरोध करें

इस उदाहरण में, आपने दो अनुरोध हेडर पास किए हैं:

  • टोकन जनरेट करने के लिए, नीचे दिए गए निर्देश का इस्तेमाल करके, Authorization हेडर में OAuth टोकन को पास करें:

    gcloud auth application-default print-access-token

    दिखाए गए टोकन का दायरा https://www.googleapis.com/auth/cloud-platform. है

  • अपने उस Google Cloud प्रोजेक्ट का आईडी या नाम पास करें जिसके लिए X-Goog-User-Project हेडर में बिलिंग की सुविधा चालू है. ज़्यादा जानने के लिए, Cloud Console में सेट अप करना देखें.

इस उदाहरण में, OAuth टोकन का इस्तेमाल करके पते की पुष्टि करने वाले एपीआई को कॉल किया गया है:

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://addressvalidation.googleapis.com/v1:validateAddress"

समस्या हल करना

अगर आपका अनुरोध इस बारे में गड़बड़ी का मैसेज देता है कि असली उपयोगकर्ता क्रेडेंशियल इस एपीआई के साथ काम नहीं करते, तो उपयोगकर्ता क्रेडेंशियल काम नहीं कर रहे देखें.