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

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

---

​

उपयोगी टूल

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

​

Postman

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

​

कोड नमूने

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

​

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

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

---

​

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

​

प्रमाणीकरण

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

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

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

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

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

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

​

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

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

​

रेट लिमिट्स

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

Lookup (GET) एंडपॉइंट्स पर ऐप-स्तर और उपयोगकर्ता-स्तर दोनों पर रेट लिमिट्स लागू होती हैं; जबकि manage (POST/DELETE) एंडपॉइंट्स उपयोगकर्ता-स्तर पर सीमित होते हैं। ऐप रेट लिमिट का मतलब है कि आप, यानी डेवलपर, किसी निर्धारित समयावधि में किसी भी App से इस एंडपॉइंट पर केवल एक निश्चित संख्या में अनुरोध कर सकते हैं (जब API Key और API Secret Key, या केवल App Access Token का उपयोग किया जाता है, तो यही सीमा लागू होती है)। उपयोगकर्ता रेट लिमिट का मतलब है कि जिस प्रमाणीकृत उपयोगकर्ता की ओर से आप अनुरोध कर रहे हैं, वह किसी भी डेवलपर ऐप के माध्यम से केवल एक निश्चित संख्या में ही सूची lookup कर सकता है।

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

एंडपॉइंट	HTTP method	रेट लिमिट
/2/lists/:id/members	GET	प्रति 15 मिनट 900 अनुरोध
/2/users/:id/list_memberships	GET	प्रति 15 मिनट 75 अनुरोध
/2/lists/:id/members	POST	प्रति 15 मिनट 300 अनुरोध
/2/lists/:id/members/:user_id	DELETE	प्रति 15 मिनट 300 अनुरोध

​

फ़ील्ड्स और expansions

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

• pinned_tweet_id

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

हमने fields and expansions के उपयोग पर एक मार्गदर्शिका भी जोड़ी है।

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

एंडपॉइंट	फ़ील्ड्स	Expansions
/2/lists/:id/members	user.fields, tweet.fields	pinned_tweet_id
/2/users/:id/list_memberships	list.fields, user.fields	owner_id

​

पेजिनेशन

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