इस पेज का अनुवाद Cloud Translation API से किया गया है.

Blogger JSON एपीआई: शुरू करना

इस दस्तावेज़ में बताया गया है कि आप Blogger JSON एपीआई का इस्तेमाल कैसे शुरू कर सकते हैं.

कॉन्टेंट

शुरुआती जानकारी
शुरू करने से पहले
Blogger JSON एपीआई बैकग्राउंड
कॉल करने का तरीका
1. REST
डेटा फ़ॉर्मैट
1. JSON

सुविधा के बारे में जानकारी

यह दस्तावेज़ उन डेवलपर के लिए है जो ऐसे ऐप्लिकेशन लिखना चाहते हैं जो Blogger JSON एपीआई के साथ इंटरैक्ट कर सकें.

Blogger JSON एपीआई, Blogger डेटा एपीआई का 2.0 वर्शन बढ़ाता है. अगर आप XML के बजाय JSON फ़ॉर्मैट में Blogger से डेटा पाना चाहते हैं, तो Blogger JSON API का इस्तेमाल करें. अगर आपको एक्सएमएल फ़ॉर्मैट में डेटा वापस पाना है, तो Blogger डेटा एपीआई का इस्तेमाल करें.

फ़िलहाल, Blogger JSON API का यह वर्शन सिर्फ़ पढ़ने के लिए है. हालांकि, हम इसे पढ़ने/रीड करने की सुविधाओं के साथ-साथ दूसरी सुविधाओं को भी जोड़ने पर विचार कर रहे हैं. बेझिझक Blogger सहायता फ़ोरम पर दूसरी सुविधाओं का अनुरोध करें.

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

कोई Google खाता प्राप्त करें

पक्का करें कि आपने Google खाता सेट अप किया हो. हमारा सुझाव है कि आप डेवलप करने और जांच करने के लिए, एक अलग Google खाते का इस्तेमाल करें. इसकी मदद से, आप अनजाने में होने वाले डेटा के नुकसान से खुद को सुरक्षित रख सकते हैं. अगर आपके पास पहले से ही टेस्ट खाता है, तो आप पूरी तरह से तैयार हैं. अपने टेस्ट डेटा को सेट अप करने, उसमें बदलाव करने या उसे देखने के लिए आप Blogger यूज़र इंटरफ़ेस पर जा सकते हैं.

Blogger के बारे में जानें

अगर आप Blogger के कॉन्सेप्ट के बारे में नहीं जानते हैं, तो यह दस्तावेज़ पढ़ें और कोड शुरू करने से पहले यूज़र इंटरफ़ेस का इस्तेमाल करके देखें. इस दस्तावेज़ में यह माना गया है कि आपको Blogger की वेब प्रोग्रामिंग के बारे में जानकारी है. साथ ही, आप वेब डेटा फ़ॉर्मैट के बारे में भी जानते हैं.

अनुरोधों को अनुमति देने और अपने ऐप्लिकेशन की पहचान करने के बारे में जानें

जब आपका ऐप्लिकेशन निजी डेटा को ऐक्सेस करने का अनुरोध करता है तब इस अनुरोध की अनुमति किसी ऐसे उपयोगकर्ता को देनी चाहिए जिसके पास डेटा का ऐक्सेस हो.

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

एपीआई की अनुमतियों का इस्तेमाल करने और एपीआई कुंजियों का इस्तेमाल करने का तरीका जानने के लिए, एपीआई दस्तावेज़ का इस्तेमाल करें में अनुरोधों को अनुमति देना और अपने ऐप्लिकेशन की पहचान करना देखें.

Blogger JSON एपीआई बैकग्राउंड

Blogger के सिद्धांत

Blogger पांच बुनियादी सिद्धांतों पर बना है:

ब्लॉग: एपीआई का रूट कॉन्सेप्ट. ब्लॉग में पोस्ट और पेज हैं. यह एक ब्लॉग है, जिसमें ब्लॉग की मुख्य जानकारी मौजूद होती है. जैसे, ब्लॉग का नाम और जानकारी.
पोस्ट: ब्लॉग पोस्ट को पब्लिश किया जा सकता है. इसे ब्लॉग लेखक ने बनाया है. इस जानकारी का इस्तेमाल समय पर करना होता है. इससे पता चलता है कि लेखक अभी दुनिया के लिए क्या प्रकाशित करना चाहते हैं. यह समझना ज़रूरी है कि समय के साथ, ब्लॉग में कॉन्टेंट से जुड़ी उम्र पोस्ट की जाती है और इसका इस्तेमाल करना कम हो जाता है.
टिप्पणियां: टिप्पणी एक ऐसी जगह है जहां ब्लॉग पोस्ट के लेखक के अलावा, दूसरे लोग अपनी लिखी प्रतिक्रिया देते हैं. ईंटों से लेकर गुलदस्ते तक सब कुछ.
पेज: पेज स्टैटिक कॉन्टेंट के लिए जगह है, जैसे कि जीवनी से जुड़ी जानकारी या उपयोगकर्ता से संपर्क करने के तरीके. आम तौर पर, यह ऐसी जानकारी होती है जो अक्सर नहीं बदलती.
उपयोगकर्ता: उपयोगकर्ता वह व्यक्ति होता है जो Blogger के साथ इंटरैक्ट करता है, चाहे वह लेखक, एडमिन या सिर्फ़ रीडर के तौर पर काम कर रहा हो. सार्वजनिक ब्लॉग के लिए, पाठक की पहचान छिपी रह सकती है. हालांकि, निजी ब्लॉग पर किसी पाठक की पहचान, Blogger से ही होनी चाहिए.

Blogger JSON एपीआई डेटा मॉडल

संसाधन एक ऐसी इकाई होती है जिसकी डेटा आइडेंटिफ़ायर एक खास पहचान होती है. Blogger JSON एपीआई पांच तरह के संसाधनों पर काम करता है:

ब्लॉग संसाधन: किसी ब्लॉग को दिखाता है.
पोस्ट रिसॉर्स: पोस्ट दिखाता है; हर पोस्ट रिसॉर्स ब्लॉग संसाधन का चाइल्ड है.
टिप्पणियों का संसाधन: किसी खास पोस्ट पर की गई टिप्पणी दिखाता है, हर टिप्पणी संसाधन, पोस्ट संसाधन का बच्चा होता है.
पेजों का रिसॉर्स: एक स्टैटिक पेज के बारे में बताता है, हर पेज का संसाधन, किसी ब्लॉग संसाधन का चाइल्ड बेस होता है.
उपयोगकर्ता संसाधन: गैर-पहचान वाले उपयोगकर्ता को दिखाता है. इसका इस्तेमाल पेज, लेखक या टिप्पणी के लेखक की पहचान करने के लिए किया जाता है.

ब्लॉग रिसॉर्स में बच्चों के लिए दो तरह के संसाधन, पेज, और पोस्ट होते हैं.
पोस्ट करने के संसाधन में, बच्चों के लिए संसाधन मौजूद हो सकते हैं. — संसाधनों के बीच के संबंध की खास जानकारी

Blogger JSON एपीआई डेटा मॉडल, संसाधनों के ग्रुप पर आधारित होता है. इन्हें कलेक्शन कहा जाता है:

ब्लॉग्स कलेक्शन: एक <span="apicollection">ब्लॉग्स कलेक्शन में वे सभी ब्लॉग शामिल हैं जिनका ऐक्सेस उपयोगकर्ता के पास है. आप उपयोगकर्ता के हिसाब से ब्लॉग की सूची बना सकते हैं या आईडी के हिसाब से एक ब्लॉग पा सकते हैं.</span="apicollection">
पोस्ट कलेक्शन: पोस्ट इकट्ठा करने की प्रक्रिया में किसी खास ब्लॉग संसाधन के अंदर मौजूद सभी पोस्ट संसाधन शामिल होते हैं.
टिप्पणियों का कलेक्शन: टिप्पणियों के कलेक्शन में किसी खास पोस्ट रिसॉर्स के अंदर मौजूद सभी टिप्पणियां संसाधन शामिल होते हैं.
पेजों का संग्रह: पेजों के कलेक्शन में किसी खास ब्लॉग संसाधन के अंदर मौजूद सभी पेजों के रिसॉर्स शामिल होते हैं.
उपयोगकर्ताओं का कलेक्शन: उपयोगकर्ताओं के कलेक्शन में Blogger के सभी उपयोगकर्ता संसाधन होते हैं. इसलिए, इन्हें सूची में शामिल नहीं किया जा सकता. उपयोगकर्ता अपने उपयोगकर्ता संसाधन (लेकिन किसी और को नहीं) की पहचान आईडी से या self पहचानकर्ता का इस्तेमाल करके कर सकता है.

Blogger JSON एपीआई से जुड़ी कार्रवाइयां

आप Blogger की JSON API (एपीआई) में, संग्रह और संसाधनों के लिए दो अलग-अलग तरीके शुरू कर सकते हैं. जैसा कि नीचे दी गई टेबल में बताया गया है.

कार्रवाई	जानकारी	REST एचटीटीपी मैपिंग
list	कलेक्शन में मौजूद सभी संसाधनों की सूची बनाता है.	कलेक्शन यूआरआई पर `GET`.
पाएं	एक खास रिसॉर्स मिलता है.	संसाधन यूआरआई पर `GET`.

इस टेबल में बताया गया है कि हर तरीके के लिए कौनसे तरीके काम करते हैं. निजी ब्लॉग पर सभी सूची और पाएं कार्रवाइयों के लिए पुष्टि करना ज़रूरी है.

संसाधन प्रकार	काम करने के तरीके
	list	पाएं
ब्लॉग	हाँ	हाँ
पोस्ट	हाँ	हाँ
टिप्पणियां	हाँ	हाँ
पेज	हाँ	हाँ
उपयोगकर्ता	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 JSON एपीआई में REST

काम करने वाले Blogger ऑपरेशन सीधे REST एचटीटीपी कार्रवाइयों पर मैप होते हैं, जैसा कि Blogger JSON एपीआई ऑपरेशन में बताया गया है.

Blogger JSON एपीआई यूआरआई का खास फ़ॉर्मैट यह है:

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 एपीआई के संदर्भ दस्तावेज़ में दी गई है.

Blogger JSON एपीआई में इसके काम करने के तरीके से जुड़े कुछ उदाहरण यहां दिए गए हैं.

उन ब्लॉग की सूची बनाएं जिनके, पुष्टि किए गए उपयोगकर्ता के पास ऐक्सेस है:

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

Blogger के एपीआई का इस्तेमाल करके, JavaScript से REST का इस्तेमाल करके 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 देखें.