इस दस्तावेज़ में बताया गया है कि Blogger API का इस्तेमाल शुरू कैसे किया जाता है.
शुरू करने से पहले
कोई Google खाता प्राप्त करें
पक्का करें कि आपने Google खाता सेट अप किया हो. हमारा सुझाव है कि आप डेवलप करने और जांच करने के लिए, एक अलग Google खाते का इस्तेमाल करें. इसकी मदद से, आप अनजाने में होने वाले डेटा के नुकसान से खुद को सुरक्षित रख सकते हैं. अगर आपके पास पहले से ही टेस्ट खाता है, तो आप पूरी तरह से तैयार हैं. अपने टेस्ट डेटा को सेट अप करने, उसमें बदलाव करने या उसे देखने के लिए आप Blogger यूज़र इंटरफ़ेस पर जा सकते हैं.
Blogger के बारे में जानें
अगर आप Blogger के कॉन्सेप्ट के बारे में नहीं जानते हैं, तो यह दस्तावेज़ पढ़ें और कोड शुरू करने से पहले यूज़र इंटरफ़ेस का इस्तेमाल करके देखें. इस दस्तावेज़ में यह माना गया है कि आपको Blogger की वेब प्रोग्रामिंग के बारे में जानकारी है. साथ ही, आप वेब डेटा फ़ॉर्मैट के बारे में भी जानते हैं.
अनुरोधों को अनुमति देने और अपने ऐप्लिकेशन की पहचान करने के बारे में जानें
जब आपका ऐप्लिकेशन निजी डेटा को ऐक्सेस करने का अनुरोध करता है तब इस अनुरोध की अनुमति किसी ऐसे उपयोगकर्ता को देनी चाहिए जिसके पास डेटा का ऐक्सेस हो.
जब आपका ऐप्लिकेशन सार्वजनिक डेटा का अनुरोध करता है, तब इस अनुरोध को अनुमति देने की ज़रूरत नहीं होती. हालांकि, इसे आइडेंटिफ़ायर के साथ दिखाया जाता है, जैसे कि एपीआई की.
एपीआई की अनुमतियों का इस्तेमाल करने और एपीआई कुंजियों का इस्तेमाल करने का तरीका जानने के लिए, एपीआई दस्तावेज़ का इस्तेमाल करें में अनुरोधों को अनुमति देना और अपने ऐप्लिकेशन की पहचान करना देखें.
Blogger एपीआई का बैकग्राउंड
Blogger के सिद्धांत
Blogger पांच बुनियादी सिद्धांतों पर बना है:
- ब्लॉग: एपीआई का रूट कॉन्सेप्ट. ब्लॉग में पोस्ट और पेज हैं. यह एक ब्लॉग है, जिसमें ब्लॉग की मुख्य जानकारी मौजूद होती है. जैसे, ब्लॉग का नाम और जानकारी.
- पोस्ट: ब्लॉग पोस्ट को पब्लिश किया जा सकता है. इसे ब्लॉग लेखक ने बनाया है. इस जानकारी का इस्तेमाल समय पर करना होता है. इससे पता चलता है कि लेखक अभी दुनिया के लिए क्या प्रकाशित करना चाहते हैं. यह समझना ज़रूरी है कि समय के साथ, ब्लॉग में कॉन्टेंट से जुड़ी उम्र पोस्ट की जाती है और इसका इस्तेमाल करना कम हो जाता है.
- टिप्पणियां: टिप्पणी एक ऐसी जगह है जहां ब्लॉग पोस्ट के लेखक के अलावा, दूसरे लोग अपनी लिखी प्रतिक्रिया देते हैं. ईंटों से लेकर गुलदस्ते तक सब कुछ.
- पेज: पेज स्टैटिक कॉन्टेंट के लिए जगह है, जैसे कि जीवनी से जुड़ी जानकारी या उपयोगकर्ता से संपर्क करने के तरीके. आम तौर पर, यह ऐसी जानकारी होती है जो अक्सर नहीं बदलती.
- उपयोगकर्ता: उपयोगकर्ता वह व्यक्ति होता है जो Blogger के साथ इंटरैक्ट करता है, चाहे वह लेखक, एडमिन या सिर्फ़ रीडर के तौर पर काम कर रहा हो. सार्वजनिक ब्लॉग के लिए, पाठक की पहचान छिपी रह सकती है. हालांकि, निजी ब्लॉग पर किसी पाठक की पहचान, Blogger से ही होनी चाहिए.
Blogger API डेटा मॉडल
संसाधन एक ऐसी इकाई होती है जिसकी डेटा आइडेंटिफ़ायर एक खास पहचान होती है. Blogger JSON एपीआई पांच तरह के संसाधनों पर काम करता है:
- ब्लॉग संसाधन: किसी ब्लॉग को दिखाता है.
- पोस्ट रिसॉर्स: किसी पोस्ट को दिखाता है; हर पोस्ट रिसॉर्स ब्लॉग संसाधन का चाइल्ड होता है.
- टिप्पणियों के लिए संसाधन: किसी खास पोस्ट पर की गई टिप्पणी दिखाता है; हर टिप्पणी एक संसाधन के तौर पर मार्क की गई होती है.
- पेजों का रिसॉर्स: स्टैटिक पेज के बारे में बताता है. हर पेज का रिसॉर्स, किसी ब्लॉग संसाधन का चाइल्ड बेस होता है.
- उपयोगकर्ता संसाधन: पहचान ज़ाहिर न करने वाला उपयोगकर्ता. इसका इस्तेमाल पेज के लेखक, पोस्ट या टिप्पणी की पहचान करने के लिए किया जाता है.
Blogger API डेटा मॉडल, संसाधनों के ग्रुप पर आधारित होता है. इन्हें कलेक्शन कहा जाता है:
- ब्लॉग्स कलेक्शन
- एक &&t;span="apicollection">ब्लॉग संग्रह में वे सभी ब्लॉग शामिल हैं जिनका ऐक्सेस उपयोगकर्ता के पास है. आप उपयोगकर्ता को ब्लॉग की सूची बना सकते हैं या आईडी के हिसाब से एक ब्लॉग पा सकते हैं.</span="apicollection">
- पोस्ट कलेक्शन
- पोस्ट इकट्ठा करने की प्रक्रिया में किसी खास ब्लॉग संसाधन के अंदर मौजूद सभी पोस्ट संसाधन शामिल होते हैं.
- टिप्पणियों का कलेक्शन
- A टिप्पणियों का संग्रह सभी टिप्पणियों के संसाधन किसी खास पोस्ट संसाधन के अंदर होते हैं.
- पेजों का संग्रह
- पेजों के कलेक्शन में किसी खास ब्लॉग संसाधन के अंदर मौजूद सभी पेजों के रिसॉर्स शामिल होते हैं.
- उपयोगकर्ताओं का कलेक्शन
- उपयोगकर्ताओं के कलेक्शन में Blogger के सभी
उपयोगकर्ताओं के संसाधन शामिल होते हैं. इसलिए, उन्हें सूची में शामिल नहीं किया जा सकता. उपयोगकर्ता अपने उपयोगकर्ताओं के लिए रिसॉर्स हासिल कर सकता है.
हालांकि, किसी अन्य व्यक्ति के आईडी से या
selfआइडेंटिफ़ायर का इस्तेमाल करके, उसे ऐक्सेस नहीं किया जा सकता.
Blogger API से जुड़ी कार्रवाइयां
Blogger API में, कलेक्शन और रिसॉर्स के लिए कई तरीकों को अपनाया जा सकता है. इसके बारे में नीचे बताया गया है.
| कार्रवाई | जानकारी | REST एचटीटीपी मैपिंग |
|---|---|---|
| list | कलेक्शन में मौजूद सभी संसाधनों की सूची बनाता है. | कलेक्शन यूआरआई पर GET. |
| पाएं | एक खास रिसॉर्स मिलता है. | संसाधन यूआरआई पर GET. |
| getByUrl | यह संसाधन, यूआरएल की मदद से ढूंढता है. | GET को यूआरएल में पैरामीटर के तौर पर पास किया गया. |
| getByPath | यह किसी संसाधन को उसके पाथ में ढूंढता है. | GET को पाथ के तौर पर पास किया गया. |
| listByUser | उपयोगकर्ता के मालिकाना हक वाले संसाधनों की सूची बनाता है. | उपयोगकर्ता के मालिकाना हक वाले कलेक्शन पर GET. |
| search | क्वेरी पैरामीटर के आधार पर संसाधन खोजें. | सर्च यूआरएल पर GET, जिसमें पैरामीटर का इस्तेमाल करके क्वेरी पास की गई थी. |
| शामिल करें | किसी कलेक्शन में संसाधन बनाएं. | कलेक्शन यूआरआई पर POST. |
| मिटाएं | किसी संसाधन को मिटाता है. | संसाधन यूआरआई पर DELETE. |
| पैच | पैच सिमेंटिक का इस्तेमाल करके किसी संसाधन को अपडेट करें. | संसाधन यूआरआई पर PATCH. |
| अपडेट करें | संसाधन अपडेट करें. | संसाधन यूआरआई पर PUT. |
इस टेबल में बताया गया है कि हर तरीके के लिए कौनसे तरीके काम करते हैं. निजी ब्लॉग पर सभी सूची और पाएं कार्रवाइयों के लिए पुष्टि करना ज़रूरी है.
संसाधन प्रकार |
काम करने के तरीके |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| list | पाएं | getByUrl | getByPath | listByUser | खोजें | शामिल करें | मिटाएं | पैच | अपडेट करें | |
| ब्लॉग | no | हाँ | हाँ | no | हाँ | no | नहीं | नहीं | नहीं | no |
| पोस्ट | हाँ | हाँ | no | हाँ | no | हाँ | हाँ | हाँ | हाँ | हाँ |
| टिप्पणियां | हाँ | हाँ | no | नहीं | नहीं | नहीं | नहीं | नहीं | नहीं | no |
| पेज | हाँ | हाँ | no | नहीं | नहीं | नहीं | नहीं | नहीं | नहीं | no |
| उपयोगकर्ता | no | हाँ | no | नहीं | नहीं | नहीं | नहीं | नहीं | नहीं | no |
कॉल करने के तरीके
एपीआई को शुरू करने के कई तरीके हैं:
- REST को सीधे या JavaScript से इस्तेमाल करें (सर्वर-साइड कोड की ज़रूरत नहीं है)
- क्लाइंट लाइब्रेरी का इस्तेमाल करके.
बाकी
REST, सॉफ़्टवेयर आर्किटेक्चर की स्टाइल है. यह डेटा का अनुरोध करने और उसमें बदलाव करने का एक आसान और एक जैसा तरीका उपलब्ध कराता है.
REST का छोटा नाम "Re ज़रूरी तरीके से जुड़ा राज्य ट्रांसफ़र." Google API के संदर्भ में, यह Google को सेव किए गए डेटा को फिर से पाने के लिए, एचटीटीपी कार्रवाइयों का इस्तेमाल करने के बारे में बताता है.
RESTful सिस्टम में, डेटा को डेटा स्टोर में स्टोर किया जाता है; क्लाइंट एक अनुरोध भेजता है कि सर्वर कोई खास कार्रवाई (जैसे कि किसी संसाधन को बनाना, वापस पाना, अपडेट करना या मिटाना) करता है और सर्वर कार्रवाई करता है और अक्सर बताए गए संसाधन को दिखाता है.
Google's RESTful API में, क्लाइंट POST, GET, PUT या DELETE जैसे एचटीटीपी कार्रवाई का इस्तेमाल करके कार्रवाई तय करता है. यह एक संसाधन को इस फ़ॉर्म के ग्लोबल-यूनीक यूआरआई के ज़रिए बताता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई संसाधनों के यूनीक एचटीटीपी से ऐक्सेस किए जा सकने वाले यूआरआई होते हैं. इसलिए, REST की मदद से डेटा को कैश मेमोरी में सेव किया जाता है. साथ ही, इसे वेब और उपलब्ध इंफ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
आपको एचटीटीपी 1.1 के स्टैंडर्ड दस्तावेज़ों में मैथड की परिभाषाएं काम की लग सकती हैं. इनमें GET, POST, PUT, और DELETE के लिए खास जानकारी शामिल है.
Blogger API में REST
काम करने वाले Blogger ऑपरेशन, सीधे REST एचटीटीपी कार्रवाइयों पर मैप होते हैं, जैसा कि Blogger API की कार्रवाइयों में बताया गया है.
Blogger एपीआई यूआरआई का खास फ़ॉर्मैट:
https://www.googleapis.com/blogger/v3/users/userId https://www.googleapis.com/blogger/v3/users/self https://www.googleapis.com/blogger/v3/users/userId/blogs https://www.googleapis.com/blogger/v3/users/self/blogs https://www.googleapis.com/blogger/v3/blogs/blogId https://www.googleapis.com/blogger/v3/blogs/byurl https://www.googleapis.com/blogger/v3/blogs/blogId/posts https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v3/blogs/blogId/pages https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId
इस्तेमाल किए गए यूआरआई की पूरी जानकारी और एपीआई में काम करने वाले हर ऑपरेशन के नतीजों की खास जानकारी Blogger API पहचान फ़ाइल दस्तावेज़ में दी गई है.
उदाहरण
उन ब्लॉग की सूची बनाएं जिनके, पुष्टि किए गए उपयोगकर्ता के पास ऐक्सेस है:
GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY
code.blogger.com ब्लॉग पर पोस्ट पाएं, जिसमें ब्लॉग आईडी 3213900 हो:
GET https://www.googleapis.com/blogger/v3/blogs/3213900?key=YOUR-API-KEY
JavaScript से REST
Blogger के एपीआई को, JavaScript से शुरू करने के लिए,
callback क्वेरी पैरामीटर का इस्तेमाल करें और कॉलबैक फ़ंक्शन दें.
जब ब्राउज़र स्क्रिप्ट को लोड करता है, तो कॉलबैक फ़ंक्शन लागू किया जाता है और
कॉलबैक फ़ंक्शन को रिस्पॉन्स दिया जाता है. इस तरीके का इस्तेमाल करके,
ऐसे रिच ऐप्लिकेशन लिखे जा सकते हैं जिनमें सर्वर साइड कोड के बिना, Blogger का डेटा दिखता है.
नीचे दिए गए उदाहरण में, YOUR-API-KEY को अपनी एपीआई कुंजी से बदलने के बाद, code.blogger.com ब्लॉग से एक पोस्ट को फिर से हासिल किया गया है.
<html>
<head>
<title>Blogger 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/v3/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY"></script>
</body>
</html>
डेटा फ़ॉर्मैट
JSON
JSON (JavaScript ऑब्जेक्ट नोटेशन) एक सामान्य डेटा-आधारित डेटा फ़ॉर्मैट है, जो आर्बिट्रेरी डेटा स्ट्रक्चर को टेक्स्ट के रूप में आसान तरीके से दिखाता है. ज़्यादा जानकारी के लिए, json.org देखें.