एकीकरण मार्गदर्शिका

यह पृष्ठ सूची पोस्ट्स लुकअप एंडपॉइंट को एकीकृत करने के लिए उपयोगी टूल और प्रमुख अवधारणाएँ बताता है।

---

​

उपयोगी टूल्स

इस endpoint को इंटीग्रेट करने में आपकी मदद करने वाली कुछ मुख्य अवधारणाओं पर जाने से पहले, हम सुझाव देते हैं कि आप निम्नलिखित से परिचित हो जाएँ:

​

Postman

Postman एक बेहतरीन टूल है, जिसका इस्तेमाल आप किसी endpoint को टेस्ट करने के लिए कर सकते हैं। हर Postman अनुरोध में सभी path और body parameter शामिल होते हैं, ताकि आप जल्दी समझ सकें कि आपके लिए क्या उपलब्ध है। हमारे Postman collections के बारे में अधिक जानने के लिए, कृपया हमारा “Postman का उपयोग करना” पेज देखें।

​

कोड नमूने

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

​

तृतीय-पक्ष लाइब्रेरी

शुरुआत करने में मदद के लिए हमारे समुदायों की तृतीय-पक्ष लाइब्रेरी में से किसी एक का उपयोग करें। सही वर्शन टैग देखकर आप ऐसी लाइब्रेरी ढूँढ सकते हैं, जो v2 endpoints के साथ काम करती हो।

---

​

प्रमुख अवधारणाएँ

​

प्रमाणीकरण

सभी X API v2 एंडपॉइंट्स के लिए यह आवश्यक है कि आप अपने अनुरोधों को क्रेडेंशियल्स के एक सेट से प्रमाणित करें, जिन्हें keys और tokens भी कहा जाता है। इस एंडपॉइंट पर अपने अनुरोधों को प्रमाणित करने के लिए आप OAuth 1.0a User Context, App only, या PKCE के साथ OAuth 2.0 Authorization Code में से किसी का भी उपयोग कर सकते हैं।

OAuth 1.0a User Context का अर्थ है कि सफल अनुरोध करने के लिए आपको API Keys और user Access Tokens के एक सेट का उपयोग करना होगा। Access Tokens उस user से संबद्ध होने चाहिए जिसकी ओर से आप अनुरोध कर रहे हैं। यदि आप किसी दूसरे user के लिए Access Tokens का एक सेट जनरेट करना चाहते हैं, तो उसे 3-legged OAuth flow का उपयोग करके आपके ऐप को अधिकृत करना होगा।

कृपया ध्यान दें कि OAuth 1.0a का उपयोग करना कठिन हो सकता है। यदि आप इस authentication method से परिचित नहीं हैं, तो हम अनुशंसा करते हैं कि आप library का उपयोग करें, Postman जैसे किसी tool का उपयोग करें, या अपने अनुरोधों को प्रमाणित करने के लिए OAuth 2.0 या App only में से किसी एक का उपयोग करें।

OAuth 2.0 Authorization Code with PKCE किसी application के scope पर अधिक नियंत्रण देता है और कई devices पर authorization flows का समर्थन करता है। OAuth 2.0 आपको विशिष्ट, सूक्ष्म scopes चुनने देता है, जो किसी user की ओर से आपको खास permissions प्रदान करते हैं।

अपने ऐप में OAuth 2.0 सक्षम करने के लिए, आपको डेवलपर कंसोल के App settings section में मौजूद अपने ऐप की authentication settings में इसे सक्षम करना होगा।

App only के लिए बस इतना आवश्यक है कि आप अपने अनुरोध के साथ एक App only Access Token पास करें। आप या तो किसी developer ऐप के भीतर सीधे App only Access Token जनरेट कर सकते हैं, या POST oauth2/token एंडपॉइंट का उपयोग करके एक जनरेट कर सकते हैं।

​

डेवलपर कंसोल, प्रोजेक्ट्स, और डेवलपर ऐप्स

X API v2 एंडपॉइंट्स के साथ काम करने वाले प्रमाणीकरण क्रेडेंशियल्स का एक सेट प्राप्त करने के लिए, आपको डेवलपर खाते के लिए साइन अप करना होगा, उस खाते के भीतर एक प्रोजेक्ट सेट अप करना होगा, और उस प्रोजेक्ट के भीतर एक डेवलपर ऐप बनाना होगा। इसके बाद, आप अपने डेवलपर ऐप के भीतर अपनी कीज़ और टोकन देख सकते हैं।

​

रेट लिमिट्स

हर दिन, कई हज़ार डेवलपर X API को अनुरोध भेजते हैं। इन अनुरोधों की बहुत बड़ी मात्रा को प्रबंधित करने में मदद के लिए, प्रत्येक endpoint पर रेट लिमिट्स लागू की जाती हैं, जो आपके ऐप की ओर से या किसी प्रमाणित उपयोगकर्ता की ओर से किए जा सकने वाले अनुरोधों की संख्या को सीमित करती हैं।

इस endpoint पर ऐप-स्तर और उपयोगकर्ता-स्तर, दोनों पर रेट लिमिट लागू है। ऐप रेट लिमिट का मतलब है कि आप, एक डेवलपर के रूप में, किसी भी दिए गए ऐप से (या तो API Key और API Secret Key, या बेयरर टोकन का उपयोग करके) एक निश्चित समयावधि में इस endpoint पर केवल एक निश्चित संख्या में अनुरोध कर सकते हैं। उपयोगकर्ता रेट लिमिट का मतलब है कि जिस प्रमाणित उपयोगकर्ता की ओर से आप अनुरोध कर रहे हैं, वह किसी भी डेवलपर ऐप में केवल एक निश्चित संख्या में ही सूची पोस्ट्स लुकअप कर सकता है।

नीचे दिया गया चार्ट प्रत्येक endpoint के लिए रेट लिमिट्स दिखाता है।

Endpoint	HTTP method	Rate limit
/2/lists/:id/tweets	GET	प्रति 15 मिनट 900 अनुरोध

​

फ़ील्ड्स और expansions

X API v2 का GET एंडपॉइंट उपयोगकर्ताओं को fields और expansions नामक टूल्स के एक सेट की मदद से यह चुनने देता है कि API से लौटने वाले डेटा में वे ठीक-ठीक क्या पाना चाहते हैं। expansions पैरामीटर आपको payload में संदर्भित ऑब्जेक्ट्स को विस्तृत करने देता है। उदाहरण के लिए, सूची पोस्ट्स का लुकअप करने पर आप निम्नलिखित expansions प्राप्त कर सकते हैं:

• author_id

fields पैरामीटर आपको यह चुनने देता है कि अलग-अलग डेटा ऑब्जेक्ट्स के भीतर कौन-से फ़ील्ड्स लौटाए जाएँ। यह एंडपॉइंट मुख्य रूप से पोस्ट ऑब्जेक्ट्स लौटाता है। डिफ़ॉल्ट रूप से, Post object id और text फ़ील्ड्स लौटाता है। tweet.created_at या tweet.lang जैसे अतिरिक्त फ़ील्ड्स पाने के लिए, आपको उन्हें fields पैरामीटर का उपयोग करके विशेष रूप से अनुरोध करना होगा।

हमने X API v2 data dictionary में fields and expansions को साथ में इस्तेमाल करने पर एक गाइड जोड़ी है।

नीचे दिया गया चार्ट लुकअप एंडपॉइंट के लिए उपलब्ध फ़ील्ड्स और expansions दिखाता है:

Endpoint	Fields	Expansions
/2/lists/:id/tweets	tweet.fields, user.fields	author_id

​

पेजिनेशन

सूची पोस्ट्स को देखने पर बहुत अधिक डेटा लौट सकता है। यह सुनिश्चित करने के लिए कि हम किसी भी समय एकसमान और उच्च-प्रदर्शन वाले परिणाम लौटाएँ, हम पेजिनेशन का उपयोग करते हैं। पेजिनेशन, X API v2 endpoints की एक सुविधा है, जिसका उपयोग तब किया जाता है जब एक ही रिस्पॉन्स में लौटाए जा सकने वाले परिणामों से अधिक परिणाम हों। जब ऐसा होता है, तो डेटा ‘pages’ की एक श्रृंखला में लौटाया जाता है। परिणामों को पेजिनेट करने के तरीके के बारे में अधिक जानें