अहम जानकारी: हम 30 सितंबर, 2024 से, v2.0 JSON API के साथ काम करना बंद कर देंगे. काम करते रहने के लिए, अपने उन ऐप्लिकेशन को अपडेट करें जो v2.0 JSON API का इस्तेमाल करके, एपीआई के नए वर्शन पर काम करते हैं. सबसे नए वर्शन के लिए, बाईं ओर के नेविगेशन बार में दिए गए लिंक का इस्तेमाल करें.
इस दस्तावेज़ में Blogger JSON API का इस्तेमाल शुरू करने का तरीका बताया गया है.
विषय सूची
शुरुआती जानकारी
यह दस्तावेज़ उन डेवलपर के लिए है जो ऐसे ऐप्लिकेशन लिखना चाहते हैं जो Blogger JSON API से इंटरैक्ट कर सकें.
Blogger JSON एपीआई, Blogger Data API के 2.0 वर्शन पर काम करता है. अगर आपको Blogger से एक्सएमएल के बजाय 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">ब्लॉग संग्रह में वे सभी ब्लॉग होते हैं जिन्हें ऐक्सेस करने के अधिकार किसी उपयोगकर्ता के पास होते हैं. उपयोगकर्ताओं के हिसाब से ब्लॉग की सूची बनाई जा सकती है या आईडी के हिसाब से सिर्फ़ एक ब्लॉग को वापस लाया जा सकता है.</span="apicollection">
- पोस्ट कलेक्शन
- पोस्ट कलेक्शन में, किसी ब्लॉग संसाधन में मौजूद सभी पोस्ट रिसॉर्स शामिल होते हैं.
- टिप्पणियों का कलेक्शन
- टिप्पणियों के कलेक्शन में, किसी खास पोस्ट संसाधन में मौजूद सभी टिप्पणियां संसाधन शामिल होते हैं.
- पेजों का कलेक्शन
- पेज के कलेक्शन में, किसी खास ब्लॉग संसाधन में मौजूद सभी पेज रिसॉर्स शामिल होते हैं.
- उपयोगकर्ताओं से जुड़ा कलेक्शन
- उपयोगकर्ताओं से जुड़े कलेक्शन में Blogger पर मौजूद
सभी उपयोगकर्ता संसाधन शामिल होते हैं. इसलिए, इन्हें सूची में शामिल नहीं किया जा सकता. उपयोगकर्ता, आईडी के ज़रिए या
selfआइडेंटिफ़ायर का इस्तेमाल करके, अपना खुद का उपयोगकर्ता संसाधन वापस पा सकता है, लेकिन किसी को नहीं.
Blogger JSON API (एपीआई) की कार्रवाइयां
Blogger JSON API में कलेक्शन और रिसॉर्स के लिए दो अलग-अलग तरीके इस्तेमाल किए जा सकते हैं, जैसा कि इस टेबल में बताया गया है.
| कार्रवाई | ब्यौरा | REST एचटीटीपी मैपिंग |
|---|---|---|
| list | यह किसी कलेक्शन में मौजूद सभी संसाधनों की सूची बनाता है. | संग्रह यूआरआई पर GET. |
| get | किसी खास संसाधन को खोजता है. | संसाधन यूआरआई पर GET. |
नीचे दी गई टेबल में दिखाया गया है कि हर तरह के संसाधन के साथ कौनसे तरीके इस्तेमाल किए जा सकते हैं. निजी ब्लॉग पर सभी सूची और get कार्रवाइयों के लिए पुष्टि करना ज़रूरी है.
संसाधन किस तरह का है |
इस्तेमाल किए जा सकने वाले तरीके |
|
|---|---|---|
| सूची | पाएं | |
| ब्लॉग | हां | हां |
| पोस्ट | हां | हां |
| टिप्पणियां | हां | हां |
| पेज | हां | हां |
| उपयोगकर्ता | no | हां |
कॉल करने के तरीके
एपीआई को शुरू करने के कई तरीके हैं:
- सीधे REST पर या JavaScript का इस्तेमाल करना (सर्वर साइड कोड की ज़रूरत नहीं है)
- क्लाइंट लाइब्रेरी का इस्तेमाल करके.
आराम
REST, सॉफ़्टवेयर आर्किटेक्चर की एक स्टाइल है, जो डेटा का अनुरोध करने और उसमें बदलाव करने का आसान और एक जैसा तरीका उपलब्ध कराती है.
REST शब्द, "रिप्रज़ेंटेशनल स्टेट ट्रांसफ़र" से छोटा होता है. Google API के संदर्भ में, इसका मतलब है Google के स्टोर किए गए डेटा को पाने और उसमें बदलाव करने के लिए, एचटीटीपी क्रियाओं का इस्तेमाल करना.
RESTफ़ुल सिस्टम में, रिसॉर्स, डेटा स्टोर में सेव किए जाते हैं. क्लाइंट, सर्वर से कोई खास कार्रवाई (जैसे कि संसाधन बनाना, वापस पाना, अपडेट करना या मिटाना) करने का अनुरोध भेजता है. इसके अलावा, सर्वर कार्रवाई करता है और जवाब भेजता है. अक्सर, बताए गए संसाधन के रूप में ऐसा किया जाता है.
Google के RESTful एपीआई में, क्लाइंट POST, GET, PUT या DELETE जैसी एचटीटीपी कार्रवाई का इस्तेमाल करके, किसी कार्रवाई के बारे में बताता है. यह नीचे दिए गए फ़ॉर्म के दुनिया भर में लागू होने वाले यूनीक यूआरआई की मदद से संसाधन के बारे में बताता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई रिसॉर्स में एचटीटीपी ऐक्सेस करने लायक यूनीक यूआरआई होते हैं, इसलिए REST डेटा को कैश मेमोरी में सेव करने की सुविधा चालू करती है. साथ ही, इसे वेब के डिस्ट्रिब्यूटेड इंफ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
आपको एचटीटीपी 1.1 स्टैंडर्ड दस्तावेज़ में, तरीके की परिभाषाएं मददगार लग सकती हैं. इनमें GET, POST, PUT, और DELETE के लिए निर्देश शामिल हैं.
Blogger JSON एपीआई में REST
Blogger पर काम करने वाली कार्रवाइयां, सीधे REST एचटीटीपी कार्रवाइयों पर मैप की जाती हैं, जैसा कि Blogger JSON एपीआई की कार्रवाइयां में बताया गया है.
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 एपीआई को शुरू किया जा सकता है. इसके लिए, callback क्वेरी पैरामीटर और कॉलबैक फ़ंक्शन का इस्तेमाल करें. इससे, ऐसे ऐप्लिकेशन बनाए जा सकते हैं जो Blogger का डेटा दिखाते हैं. इसके लिए, सर्वर साइड कोड लिखने की ज़रूरत नहीं होती.
नीचे दिए गए उदाहरण में, code.blogger.com ब्लॉग से एक पोस्ट दिखाई गई है (YOUR-API-KEY को अपनी एपीआई कुंजी से बदलने के बाद).
<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 ऑब्जेक्ट नोटेशन) एक सामान्य और भाषा पर निर्भर डेटा फ़ॉर्मैट है. यह आर्बिट्रेरी डेटा स्ट्रक्चर को टेक्स्ट के तौर पर आसानी से दिखाता है. ज़्यादा जानकारी के लिए, json.org देखें.