एकीकरण गाइड

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

---

​

उपयोगी टूल

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

​

Postman

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

​

कोड नमूने

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

​

थर्ड-पार्टी लाइब्रेरी

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

---

​

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

​

प्रमाणीकरण

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

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

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

​

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

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

​

रेट लिमिट्स

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

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

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

Endpoint	HTTP method	रेट लिमिट
/2/users/:id/pinned_lists	POST	15 मिनट में 50 अनुरोध
/2/users/:id/pinned_lists/:list_id	DELETE	15 मिनट में 50 अनुरोध
/2/users/:id/pinned_lists	GET	15 मिनट में 15 अनुरोध

​

फ़ील्ड्स और expansions

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

• owner_id

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

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

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

Endpoint	Fields	Expansions
/2/users/:id/pinned_lists	list.fields, user.fields	owner_id