StackExchange API मूल बातें

कभी-कभी ऐसी परिस्थितियाँ उत्पन्न होती हैं जब आपको एक स्क्रिप्ट या एप्लिकेशन लिखने की आवश्यकता होती है जो किसी सेवा के साथ इंटरैक्ट करती है। कई बड़ी साइटें डेवलपर्स को अपने स्वयं के एपीआई की पेशकश करती हैं, जिसे वे अपनी परियोजनाओं में उपयोग कर सकते हैं। हालांकि, प्रत्येक सेवा के अपने कार्य और एपीआई के साथ काम करने के तरीके हैं। इसलिए, अपनी परियोजनाओं में तीसरे पक्ष के एपीआई का उपयोग करना शुरू करना अक्सर मुश्किल होता है।

एक छोटे अनुप्रयोग का उपयोग करना जो एक उपयोगकर्ता को प्रमाणित करता है और प्रोफ़ाइल जानकारी के साथ उनकी नवीनतम सूचनाएं प्राप्त करता है, हम देखेंगे कि स्टैक एक्सचेंज एपीआई का उपयोग कैसे करें।

1. एक नया आवेदन पंजीकृत करें

अपना आवेदन बनाने से पहले, आपको इसे StackApps के साथ पंजीकृत करना होगा। इसके लिए एक्सेस कुंजी प्राप्त करना आवश्यक है। हम इस लिंक का अनुसरण करते हैं stackapps.com/apps/oauth/register और उन सभी फ़ील्ड्स को भरें जो वैकल्पिक के साथ चिह्नित नहीं हैं। मेरे ट्यूटोरियल के लिए, मैंने इस तरह से फ़ील्ड भरे:


"क्लाइंट साइड OAuth फ़्लो सक्षम करें" बॉक्स को चेक करना न भूलें। यह OAuth के लिए आवश्यक है - अन्यथा उपयोगकर्ता केवल एप्लिकेशन का उपयोग करने में लॉग इन करने में सक्षम नहीं होगा। जब सब कुछ भर जाए, तो संबंधित बटन पर क्लिक करें और एप्लिकेशन प्रबंधन पृष्ठ पर जाएं। वहां हमें कई कुंजियाँ मिलेंगी (क्लाइंट आईडी, क्लाइंट सीक्रेट, की)। इनमें से, केवल क्लाइंटआईड और की ही आवेदन के लिए जरूरी हैं। हम उन्हें सहेजते हैं और इस पर हम पंजीकरण प्रक्रिया पूरी करते हैं और सीधे आवेदन लिखने के लिए आगे बढ़ते हैं।

2. आरंभ करना

एक नई स्वच्छ HTML फ़ाइल बनाएँ और उसमें तुरंत स्क्रिप्ट शामिल करें:

<script type='text/javascript' src='https://api.stackexchange.com/js/2.0/all.js'></script> 

अब हम आगे के काम के लिए प्रारंभिककरण और प्राधिकरण के बुनियादी कार्यों का उपयोग कर सकते हैं। कुंजी और ग्राहक के अलावा, आरंभीकरण के लिए हमें दो अतिरिक्त मापदंडों को पारित करने की आवश्यकता है:

 SE.init({ clientId: 1, //      clientId key: 'YoUrAweSomeKey', //    key channelUrl: 'http://example.com/', //      .    ,       complete: function (data) { alert(" !"); } //     ,       }); 

यदि आपने सब कुछ सही ढंग से किया है, तो पेज लोड होने पर अलर्ट पॉप अप होना चाहिए। अन्यथा, कंसोल आउटपुट की जांच करें - क्या अनचेक किए गए चैनल पर ऐसा ही कुछ है वर्तमान डोमेन के तहत होना चाहिए ? अगर वहाँ है, तो चैनल को दोबारा जांचें। अन्यथा, आपको साइट पर नियंत्रण कक्ष में एप्लिकेशन सेटिंग्स की जांच करनी चाहिए।

3. प्राधिकरण

पिछले कोड को बदलें, जिसका नाम है: हम (डेटा) फ़ंक्शन के एक प्रोटोटाइप का निर्माण करेंगे और इसे SE.init में एक फ़ंक्शन के रूप में निर्दिष्ट करेंगे, जिसे सफल आरंभीकरण कहा जाता है:

 function auth(data) {} ... SE.init({ ... complete: auth }); 

अब प्राधिकरण लिखने का समय है। यहाँ सब कुछ सरल है:

 SE.authenticate({ success: function(data) { alert('  !'); }, //    error: function(data) { alert('    :('); }, //     }); 

मैंने इस कोड को ऑर्ट ऑफ बॉडी (डेटा) में डाल दिया है। अब, पहली बार पृष्ठ लोड होता है, एक पॉपअप दिखाई देना चाहिए। इसमें, आपको दो बटन दिए जाएंगे - आवेदन के लिए अनुमति और इनकार करने के लिए:


हालाँकि, जबकि हम केवल लॉग इन कर रहे हैं और प्राप्त आंकड़ों के साथ कुछ नहीं कर रहे हैं। लेकिन सफल होने पर, हमें आगे के काम के लिए क्लाइंट टोकन दिए जाएंगे। चलो उन्हें कहीं बचा लो। उदाहरण के लिए, इस तरह - कुछ वैश्विक वैरिएबल बनाएं जो इन बहुत टोकन को स्टोर करेंगे:

 var tokens = null; ... SE.authenticate({ success: function(data) { alert('  !'); tokens = data; }, ... ... 

अब जब हम उपयोगकर्ता को अधिकृत करने में सक्षम हैं, तो हम सीधे एपीआई के साथ काम करने के लिए आगे बढ़ सकते हैं।

4. प्रोफाइल डेटा प्राप्त करना

एपीआई हमें JSON प्रारूप में अनुरोधों की प्रतिक्रिया देता है। इसका मतलब है कि जेएस के माध्यम से लोड किए गए डेटा को आसानी से एक स्ट्रिंग प्रारूप से कुछ संरचना में परिवर्तित किया जाएगा। प्रश्न क्रॉस-डोमेन होंगे, और इसलिए मैं jQuery का उपयोग करूंगा।
उपयोगकर्ता डेटा यहां प्राप्त किया जाएगा:

 https://api.stackexchange.com/2.2/me?site=[ ] 

कुछ उपयोगकर्ता जानकारी (जैसे रेटिंग या बैज) इस बात पर निर्भर करती है कि स्टैक एक्सचेंज नेटवर्क पर किस साइट पर प्रोफ़ाइल का अनुरोध किया गया है। StackOverflow और MathOverflow से प्राप्त डेटा भिन्न हो सकते हैं। साइट का नाम सिस्टम में ही देखा जा सकता है। ठीक है। यदि हम केवल संदर्भ द्वारा डेटा का अनुरोध करते हैं, तो हमें कुछ इस तरह से मिलता है:

 {"error_id":401,"error_message":"This method requires an access_token","error_name":"access_token_required"} 

सभी संभावित त्रुटियों को यहाँ देखा जा सकता है: api.stackexchange.com/docs/error-handling

लेकिन हमें पहुँच टोकन निर्दिष्ट करने की आवश्यकता है! ऐसा करने के लिए, हम ऊपर दिए गए पते पर इन टोकन को संलग्न करेंगे:

 https://api.stackexchange.com/2.2/me?site=[ ]&key=[  key]&access_token=[tokens.accessToken]&callback=[method] 

यहां tokens.accessToken प्राधिकरण प्रक्रिया के दौरान पहले प्राप्त उपयोगकर्ता कुंजी है, और विधि कॉलबैक है जिसे डाउनलोड के अंत में बुलाया जाएगा। जवाब कुछ इस तरह होगा:

 { "items": [ { "badge_counts": { "bronze": 5, "silver": 0, "gold": 0 }, "account_id": 2760756, "is_employee": false, "last_modified_date": 1396214504, "last_access_date": 1396268249, "reputation_change_year": 62, "reputation_change_quarter": 62, "reputation_change_month": 62, "reputation_change_week": 55, "reputation_change_day": 10, "reputation": 63, "creation_date": 1368447422, "user_type": "registered", "user_id": 2377708, "age": 18, "location": "Belarus", "link": "http://stackoverflow.com/users/2377708/alex-saskevich", "display_name": "Alex Saskevich", "profile_image": "http://i.stack.imgur.com/0Vz5q.jpg?s=128&g=1" } ], "has_more": false, "quota_max": 10000, "quota_remaining": 9905 } 

ऐसे डेटा के साथ काम करना नेत्रहीन रूप से कठिन है, और इसलिए मैं एक कॉलबैक फ़ंक्शन बनाऊंगा जो प्राप्त जानकारी को एक छोटे टैबलेट में प्रस्तुत करेगा:

 function renderProfileData(data) { var items = data.items[0]; $("#reputation").text(items.reputation); $("#login").text(items.display_name); $("#bronze_badges").text(items.badge_counts.bronze); $("#silver_badges").text(items.badge_counts.silver); $("#gold_badges").text(items.badge_counts.gold); $("#profile_image").attr("src", items.profile_image); } 

सूचना मुझे इस तरह से GET अनुरोधों के माध्यम से प्राप्त हुई:

 $.get("https://api.stackexchange.com/2.2/me?site=stackoverflow&key=YoUrAwEsOmEKey&access_token=YoUrSecretToKEn&callback=profile"); 

परिणामस्वरूप, मुझे निम्नलिखित परिणाम मिला:

5. हाल की सूचनाएं

हमारे आवेदन के लिए अपठित संदेशों, सूचनाओं के बारे में जानकारी प्राप्त करने में सक्षम होने के लिए, इसे कुछ निश्चित अधिकारों का उपयोग करने की आवश्यकता है। सूचनाओं के मामले में, यह read_inbox है । हमने इसे एप्लिकेशन प्राधिकरण ब्लॉक में रखा:

 SE.authenticate({ scope: ['read_inbox'], ... }); 

हम यहाँ अधिसूचना डेटा प्राप्त करेंगे:

 https://api.stackexchange.com//2.2/notifications?pagesize=[  ]&key=[ ]&access_token=[  ]&callback=[callback-] 

हम हाल की सूचनाओं की संख्या का संकेत नहीं दे सकते हैं, लेकिन फिर हम एक ही बार में सभी सूचनाएं प्राप्त करेंगे। अनुरोध पिछले एक के समान निष्पादित किया जाता है, उत्तर कुछ इस तरह होगा:

 { "items": [ "site": { "styling": { "tag_background_color": "#FFF", "tag_foreground_color": "#000", "link_color": "#0077CC" }, "related_sites": [ { "relation": "meta", "api_site_parameter": "meta.reverseengineering", "site_url": "http://meta.reverseengineering.stackexchange.com", "name": "Reverse Engineering Meta Stack Exchange" }, { "relation": "chat", "site_url": "http://chat.stackexchange.com", "name": "Chat Stack Exchange" } ], "open_beta_date": 1364774400, "closed_beta_date": 1363651200, "site_state": "open_beta", "twitter_account": "StackReverseEng", "favicon_url": "http://cdn.sstatic.net/reverseengineering/img/favicon.ico", "icon_url": "http://cdn.sstatic.net/reverseengineering/img/apple-touch-icon.png", "audience": "researchers and developers who explore the principles of a system through analysis of its structure, function, and operation", "site_url": "http://reverseengineering.stackexchange.com", "api_site_parameter": "reverseengineering", "logo_url": "http://cdn.sstatic.net/reverseengineering/img/logo.png", "name": "Reverse Engineering", "site_type": "main_site" }, "is_unread": false, "creation_date": 1396197666, "notification_type": "badge_earned", "body": "You've earned the "Autobiographer" badge." } ], "has_more": true, "quota_max": 10000, "quota_remaining": 9994 } 

जैसा कि आप देख सकते हैं, इस मामले में, सिस्टम हमें तुरंत सूचना देता है। और उनके साथ काम करना काफी सरल है:

 function renderNotifications(data) { var items = data.items; var html = "<center> </center><br/>"; for (var i = 0; i < items.length; i ++) { var site = items[i].site.name; var icon = items[i].site.icon_url; var body = items[i].body; var str = "<div class = 'item'><img src = '" + icon + "' height = '14px' /> " + site + ": " + body + "</div>"; html += str; } $("#notifications").html(html); } 

परिणामस्वरूप, मेरे छोटे अनुप्रयोग के पृष्ठ ने इस अंतिम रूप को प्राप्त कर लिया:

6. और अब क्या?

स्टैक एक्सचेंज नेटवर्क एपीआई हमें न केवल सूचनाएं या प्रोफ़ाइल डेटा प्राप्त करने की अनुमति देता है। हम प्रश्न, टिप्पणियाँ, टैग भी प्राप्त कर सकते हैं, और हम उनके साथ बातचीत भी कर सकते हैं (प्रश्न जोड़ सकते हैं, हमारी टिप्पणियाँ संपादित कर सकते हैं)। हम उपयोगकर्ता प्रोफाइल, घटनाओं और आंकड़ों के साथ काम कर सकते हैं।

आंकड़ों की बात करें - एप्लिकेशन कंट्रोल पैनल में आप रेखांकन के रूप में प्राधिकरणों और अनुरोधों के आंकड़े देख सकते हैं। और हां, यह ध्यान में रखने योग्य है कि एक आवेदन जो किसी व्यक्तिगत फ़ंक्शन को कर सकता है, उसकी संख्या दस हजार तक सीमित है। अनुरोधों की शेष संख्या को कोटा-शवदाह क्षेत्र में JSON प्रतिक्रिया के साथ हमें भेजा जाता है।

प्रलेखन प्रश्नों के साथ भी प्रयोग कर सकता है। ऐसा करने के लिए, StackExchange एक कंसोल प्रदान करता है, जो प्रत्येक फ़ंक्शन के विवरण के तहत पाया जा सकता है।

प्रासंगिक लिंक:

• प्रलेखन: api.stackexchange.com/docs
• अनुप्रयोग नियंत्रण कक्ष: stackapps.com/apps/oauth
• कार्रवाई में आवेदन: jsfiddle.net/asaskevich/6F5kd/embedded/result