अपना पहला क्लाइंट ऐप्लिकेशन कोड करने से पहले, कुछ ऐसी चीज़ें हैं जिन्हें करना ज़रूरी है. खास तौर पर, जब आपने उन्हें पहले से नहीं किया है.
कोई Google खाता प्राप्त करें
Google API Console में प्रोजेक्ट बनाने के लिए, आपके पास Google खाता होना चाहिए. अगर आपके पास पहले से कोई खाता है, तो आपको कुछ करने की ज़रूरत नहीं है.
टेस्टिंग के लिए, आपके पास अलग से Google खाता बनाने का विकल्प भी है.
अपने क्लाइंट के लिए प्रोजेक्ट बनाना
Google के नॉलेज ग्राफ़ सर्च एपीआई को अनुरोध भेजने से पहले, आपको Google को अपने क्लाइंट के बारे में बताना होगा. साथ ही, एपीआई इस्तेमाल करने की सुविधा चालू करनी होगी. ऐसा करने के लिए, Google API Console में प्रोजेक्ट बनाएं. यह सेटिंग और एपीआई के इस्तेमाल की जानकारी वाले ग्रुप का एक नाम है. साथ ही, अपना ऐप्लिकेशन रजिस्टर करें.
Google के नॉलेज ग्राफ़ से जुड़े Search API का इस्तेमाल शुरू करने के लिए, आपको सबसे पहले सेटअप टूल का इस्तेमाल करना होगा. इससे आपको Google API Console में प्रोजेक्ट बनाने, एपीआई की सुविधा चालू करने, और क्रेडेंशियल बनाने के बारे में जानकारी मिलती है.
अगर आपने पहले से ऐसा नहीं किया है, तो अपने ऐप्लिकेशन की एपीआई कुंजी बनाएं. इसके लिए, क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें. इसके बाद, एपीआई पासकोड सेक्शन में अपनी एपीआई पासकोड खोजें.
REST की बुनियादी बातें जानें
एपीआई को दो तरीकों से शुरू किया जा सकता है:
- एचटीटीपी अनुरोध भेजना और जवाबों को पार्स करना.
- क्लाइंट लाइब्रेरी का इस्तेमाल करना.
अगर आपको क्लाइंट लाइब्रेरी का इस्तेमाल नहीं करना है, तो आपको REST के बुनियादी सिद्धांतों को समझना होगा.
REST, सॉफ़्टवेयर आर्किटेक्चर का एक स्टाइल है. यह डेटा का अनुरोध करने और उसमें बदलाव करने के लिए, आसान और एक जैसा तरीका उपलब्ध कराता है.
आरईएसटी, "रिप्रज़ेंटेशनल स्टेट ट्रांसफ़र" का छोटा रूप है. Google API के संदर्भ में, इसका मतलब है कि Google के स्टोर किए गए डेटा को वापस लाने और उसमें बदलाव करने के लिए, एचटीटीपी वर्ब का इस्तेमाल करना.
RESTful सिस्टम में, संसाधनों को डेटा स्टोर में सेव किया जाता है. क्लाइंट, सर्वर को कोई खास कार्रवाई करने का अनुरोध भेजता है. जैसे, किसी संसाधन को बनाना, वापस पाना, अपडेट करना या मिटाना. इसके बाद, सर्वर उस कार्रवाई को पूरा करता है और जवाब भेजता है. आम तौर पर, यह जवाब उस संसाधन के तौर पर भेजा जाता है.
Google के RESTful API में, क्लाइंट POST
, GET
, PUT
या DELETE
जैसे एचटीटीपी वर्ब का इस्तेमाल करके, कोई कार्रवाई करता है. यह किसी रिसॉर्स को, इस फ़ॉर्मैट में मौजूद दुनिया भर में यूनीक यूआरआई से दिखाता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई संसाधनों में, एचटीटीपी से ऐक्सेस किए जा सकने वाले यूआरआई होते हैं. इसलिए, REST, डेटा कैश मेमोरी को चालू करता है और वेब के डिस्ट्रिब्यूट किए गए इंफ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
एचटीटीपी 1.1 स्टैंडर्ड के दस्तावेज़ में, मेथड की परिभाषाएं देखी जा सकती हैं. इनमें GET
, POST
, PUT
, और DELETE
के लिए खास जानकारी शामिल होती है.
Google के नॉलेज ग्राफ़ सर्च एपीआई में REST
Google नॉलेज ग्राफ़ सर्च एपीआई के ऑपरेशन, सीधे तौर पर REST एचटीटीपी वर्ब पर मैप होते हैं.
Google के नॉलेज ग्राफ़ सर्च एपीआई के यूआरआई के लिए ये फ़ॉर्मैट इस्तेमाल किए जा सकते हैं:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
एपीआई में काम करने वाले हर ऑपरेशन के लिए इस्तेमाल किए जाने वाले यूआरआई का पूरा सेट, Google नॉलेज ग्राफ़ सर्च एपीआई के रेफ़रंस दस्तावेज़ में दिया गया है.
JSON के बारे में बुनियादी जानकारी
Google नॉलेज ग्राफ़ सर्च एपीआई, डेटा को JSON फ़ॉर्मैट में दिखाता है.
JSON (JavaScript Object Notation), डेटा का एक सामान्य फ़ॉर्मैट है. यह किसी भी भाषा पर निर्भर नहीं करता. इसमें डेटा स्ट्रक्चर को टेक्स्ट के तौर पर आसानी से दिखाया जाता है. ज़्यादा जानकारी के लिए, json.org पर जाएं.