अहम जानकारी: हम 30 सितंबर, 2024 से JSON API के वर्शन 2.0 के लिए सहायता बंद कर देंगे. यह पक्का करने के लिए कि सेवाएं काम करती रहें, अपने उन ऐप्लिकेशन को एपीआई के नए वर्शन पर अपडेट करें जो JSON API के 2.0 वर्शन पर निर्भर हैं. नए वर्शन के लिए, बाईं ओर मौजूद नेविगेशन बार में दिए गए लिंक का इस्तेमाल करें.
इस दस्तावेज़ में, Blogger JSON API का इस्तेमाल शुरू करने का तरीका बताया गया है.
कॉन्टेंट
परिचय
यह दस्तावेज़ उन डेवलपर के लिए है जो ऐसे ऐप्लिकेशन बनाना चाहते हैं जो Blogger JSON API के साथ इंटरैक्ट कर सकें.
Blogger JSON API, Blogger Data API के वर्शन 2.0 को बेहतर बनाता है. अगर आपको Blogger से XML के बजाय JSON फ़ॉर्मैट में डेटा चाहिए, तो Blogger JSON API का इस्तेमाल करें. अगर आपको एक्सएमएल फ़ॉर्मैट में डेटा चाहिए, तो Blogger Data API का इस्तेमाल करें.
फ़िलहाल, Blogger JSON API का यह वर्शन सिर्फ़ पढ़ने के लिए उपलब्ध है. हालांकि, हम इसमें पढ़ने/लिखने की सुविधाओं के साथ-साथ अन्य सुविधाएं भी जोड़ने की योजना बना रहे हैं. Blogger सहायता फ़ोरम पर जाकर, अन्य सुविधाओं का अनुरोध करें.
शुरू करने से पहले
कोई Google खाता प्राप्त करें
पक्का करें कि आपने Google खाता सेट अप किया हो. हमारा सुझाव है कि डेवलपमेंट और टेस्टिंग के लिए, आप एक अलग Google खाते का इस्तेमाल करें. इससे, अनजाने में डेटा के मिटने से बचा जा सकता है. अगर आपके पास पहले से ही कोई टेस्ट खाता है, तो आपके लिए सब कुछ सेट है. अपने टेस्ट डेटा को सेट अप करने, उसमें बदलाव करने या उसे देखने के लिए, Blogger के यूज़र इंटरफ़ेस पर जाएं.
Blogger के बारे में जानकारी
अगर आपको Blogger के कॉन्सेप्ट के बारे में नहीं पता है, तो कोड लिखने से पहले यह दस्तावेज़ पढ़ें और यूज़र इंटरफ़ेस के साथ प्रयोग करें. इस दस्तावेज़ में यह माना गया है कि आपको Blogger, वेब प्रोग्रामिंग के कॉन्सेप्ट, और वेब डेटा फ़ॉर्मैट के बारे में पता है.
अनुमति के अनुरोधों को स्वीकार करने और अपने ऐप्लिकेशन की पहचान करने के बारे में जानें
जब आपका ऐप्लिकेशन निजी डेटा को ऐक्सेस करने का अनुरोध करता है, तब इस अनुरोध की अनुमति किसी ऐसे उपयोगकर्ता को देनी चाहिए जिसके पास डेटा का ऐक्सेस हो.
जब आपका ऐप्लिकेशन सार्वजनिक डेटा का अनुरोध करता है, तो अनुरोध को अनुमति देने की ज़रूरत नहीं होती. हालांकि, इसके साथ एपीआई पासकोड जैसे आइडेंटिफ़ायर होना ज़रूरी है.
अनुरोधों को अनुमति देने और एपीआई पासकोड इस्तेमाल करने के तरीके के बारे में जानने के लिए, एपीआई का इस्तेमाल करने से जुड़े दस्तावेज़ में अनुरोधों को अनुमति देना और अपने ऐप्लिकेशन की पहचान करना लेख पढ़ें.
Blogger JSON API का बैकग्राउंड
Blogger के कॉन्सेप्ट
Blogger को इन पांच बुनियादी कॉन्सेप्ट के आधार पर बनाया गया है:
- ब्लॉग: एपीआई का मूल कॉन्सेप्ट. ब्लॉग में पोस्ट और पेज होते हैं. यह ब्लॉग की मेटा-जानकारी का कंटेनर है. जैसे, ब्लॉग का नाम और जानकारी.
- पोस्ट: ब्लॉग पोस्ट, पब्लिश किया जा सकने वाला ऐसा आइटम होता है जिसे ब्लॉग के लेखक ने बनाया है. यह जानकारी समय के हिसाब से होनी चाहिए, ताकि लेखकों को पता चल सके कि दुनिया को अब क्या पब्लिश करना है. यह समझा जाता है कि समय के साथ, ब्लॉग पोस्ट का कॉन्टेंट पुराना हो जाता है और कम काम का हो जाता है.
- टिप्पणियां: टिप्पणी करने की सुविधा की मदद से, ब्लॉग पोस्ट के लेखक के अलावा अन्य लोग भी ब्लॉग पोस्ट पर अपनी प्रतिक्रिया दे सकते हैं. ईंट से लेकर गुलदस्ते तक, सब कुछ.
- पेज: पेज पर स्टैटिक कॉन्टेंट होता है. जैसे, किसी व्यक्ति के बारे में जानकारी या उपयोगकर्ता से संपर्क करने के तरीके. आम तौर पर, यह ऐसी जानकारी होती है जो समय के साथ बदलती नहीं है.
- उपयोगकर्ता: उपयोगकर्ता वह व्यक्ति होता है जो Blogger के साथ इंटरैक्ट करता है. भले ही, वह लेखक, एडमिन या सिर्फ़ पाठक के तौर पर इंटरैक्ट करता हो. सार्वजनिक ब्लॉग के लिए, पाठकों की पहचान ज़ाहिर नहीं की जा सकती. हालांकि, निजी ब्लॉग के लिए, पाठकों की पहचान Blogger को ज़ाहिर करनी होगी.
Blogger JSON API का डेटा मॉडल
संसाधन, एक यूनीक आइडेंटिफ़ायर वाली डेटा इकाई होती है. Blogger का JSON API, पांच तरह के संसाधनों पर काम करता है:
- ब्लॉग रिसॉर्स: किसी ब्लॉग को दिखाता है.
- पोस्ट का रिसॉर्स: किसी पोस्ट को दिखाता है; हर पोस्ट का रिसॉर्स, ब्लॉग के रिसॉर्स का चाइल्ड होता है.
- टिप्पणियों का रिसॉर्स: किसी खास पोस्ट पर की गई टिप्पणी के बारे में जानकारी देता है. हर टिप्पणी का रिसॉर्स, पोस्ट के रिसॉर्स का चाइल्ड होता है.
- पेज रिसॉर्स: यह किसी स्टैटिक पेज को दिखाता है. हर पेज रिसॉर्स, ब्लॉग रिसॉर्स का चाइल्ड होता है.
- उपयोगकर्ता रिसॉर्स: इससे ऐसे उपयोगकर्ता की जानकारी मिलती है जिसने अपनी पहचान ज़ाहिर की है. इसका इस्तेमाल, किसी पेज, पोस्ट या टिप्पणी के लेखक की पहचान करने के लिए किया जाता है.
Blogger JSON API का डेटा मॉडल, संसाधनों के ग्रुप पर आधारित होता है. इन्हें कलेक्शन कहा जाता है:
- ब्लॉग का कलेक्शन
- <span="apicollection">Blogs कलेक्शन में वे सभी ब्लॉग शामिल होते हैं जिनका ऐक्सेस उपयोगकर्ता के पास होता है. ब्लॉग को उपयोगकर्ता के हिसाब से लिस्ट किया जा सकता है या आईडी के हिसाब से कोई एक ब्लॉग वापस पाया जा सकता है.</span="apicollection">
- पोस्ट का कलेक्शन
- पोस्ट कलेक्शन में, किसी खास ब्लॉग संसाधन के सभी पोस्ट संसाधन शामिल होते हैं.
- टिप्पणियों का कलेक्शन
- टिप्पणियों के कलेक्शन में, किसी खास पोस्ट संसाधन में मौजूद सभी टिप्पणियों के संसाधन शामिल होते हैं.
- पेजों का कलेक्शन
- किसी ब्लॉग रिसॉर्स में मौजूद सभी पेज रिसॉर्स, पेजों के कलेक्शन में शामिल होते हैं.
- उपयोगकर्ताओं का कलेक्शन
- उपयोगकर्ताओं के कलेक्शन में, Blogger पर मौजूद सभी उपयोगकर्ताओं के रिसॉर्स शामिल होते हैं. इसलिए, इन्हें सूची में नहीं शामिल किया जा सकता. कोई उपयोगकर्ता, आईडी या आइडेंटिफ़ायर
selfका इस्तेमाल करके, अपने उपयोगकर्ता संसाधन को वापस पा सकता है. हालांकि, वह किसी दूसरे उपयोगकर्ता का उपयोगकर्ता संसाधन वापस नहीं पा सकता.
Blogger JSON API के ऑपरेशन
Blogger JSON API में, कलेक्शन और संसाधनों पर दो अलग-अलग तरीके से कॉल किया जा सकता है. इन तरीकों के बारे में नीचे दी गई टेबल में बताया गया है.
| कार्रवाई | ब्यौरा | REST एचटीटीपी मैपिंग |
|---|---|---|
| list | किसी कलेक्शन में मौजूद सभी संसाधनों की सूची बनाता है. | GET पर क्लिक करें. |
| get | किसी खास संसाधन को ऐक्सेस करता है. | GET पर जाएं. |
नीचे दी गई टेबल में बताया गया है कि हर तरह के संसाधन के लिए कौनसे तरीके काम करते हैं. निजी ब्लॉग पर सूची और प्राप्त करें के सभी ऑपरेशन के लिए, पुष्टि करना ज़रूरी है.
संसाधन किस तरह का है |
इस्तेमाल किए जा सकने वाले तरीके |
|
|---|---|---|
| list | पाना | |
| ब्लॉग | हां | हां |
| पोस्ट | हां | हां |
| टिप्पणियां | हां | हां |
| पेज | हां | हां |
| उपयोगकर्ता | नहीं | हां |
कॉल करने के स्टाइल
एपीआई को कई तरीकों से शुरू किया जा सकता है:
- सीधे REST या JavaScript का इस्तेमाल करना (सर्वर साइड कोड की ज़रूरत नहीं है)
- क्लाइंट लाइब्रेरी का इस्तेमाल करके.
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 के लिए खास जानकारी शामिल होती है.
Blogger JSON API में REST
Blogger के साथ काम करने वाले ऑपरेशन, सीधे तौर पर REST एचटीटीपी वर्ब से मैप होते हैं. इनके बारे में Blogger JSON API के ऑपरेशन में बताया गया है.
Blogger JSON API के यूआरआई का फ़ॉर्मैट यह है:
https://www.googleapis.com/blogger/v2/users/userId https://www.googleapis.com/blogger/v2/users/self https://www.googleapis.com/blogger/v2/users/userId/blogs https://www.googleapis.com/blogger/v2/users/self/blogs https://www.googleapis.com/blogger/v2/blogs/blogId/posts https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v2/blogs/blogId/pages https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId
इस्तेमाल किए गए यूआरआई और एपीआई में काम करने वाले हर ऑपरेशन के नतीजों के बारे में पूरी जानकारी, Blogger JSON API के रेफ़रंस दस्तावेज़ में दी गई है.
Blogger JSON API में, यह सुविधा कैसे काम करती है, इसके कुछ उदाहरण यहां दिए गए हैं.
उन ब्लॉग की सूची बनाएं जिनका ऐक्सेस, पुष्टि किए गए उपयोगकर्ता के पास है:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
code.blogger.com ब्लॉग (जिसका ब्लॉग आईडी 3213900 है) पर पोस्ट पाएं:
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
JavaScript से REST
JavaScript से REST का इस्तेमाल करके, Blogger JSON API को चालू किया जा सकता है. इसके लिए, callback क्वेरी पैरामीटर और कॉलबैक फ़ंक्शन का इस्तेमाल करें. इससे आपको ऐसे बेहतर ऐप्लिकेशन लिखने की सुविधा मिलती है जो सर्वर साइड कोड लिखे बिना, Blogger का डेटा दिखाते हैं.
नीचे दिए गए उदाहरण में, YOUR-API-KEY को अपनी एपीआई पासकोड से बदलने के बाद, code.blogger.com ब्लॉग से एक पोस्ट को वापस पाया गया है.
<html>
<head>
<title>Blogger JSON API Example</title>
</head>
<body>
<div id="content"></div>
<script>
function handleResponse(response) {
document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
}
</script>
<script
src="https://www.googleapis.com/blogger/v2/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY "></script>
</body>
</html>डेटा फ़ॉर्मैट
JSON
JSON (JavaScript Object Notation), डेटा का एक सामान्य फ़ॉर्मैट है. यह किसी भी भाषा पर निर्भर नहीं करता. इसमें डेटा स्ट्रक्चर को टेक्स्ट के तौर पर आसानी से दिखाया जाता है. ज़्यादा जानकारी के लिए, json.org पर जाएं.