मुख्य सामग्री पर जाएं
यह मॉड्यूल सुरक्षित ऑथराइज़ेशन फ़्लो के लिए OAuth2 PKCE (Proof Key for Code Exchange) प्रमाणीकरण सुविधा प्रदान करता है। इसमें कोड वेरिफ़ायर जनरेट करना, टोकन प्रबंधन, और स्वचालित टोकन रीफ़्रेश जैसी क्षमताएँ शामिल हैं।

class xdk.oauth2_auth.OAuth2PKCEAuth

X API के लिए OAuth2 PKCE प्रमाणीकरण।

पैरामीटर

str
डिफ़ॉल्ट:"'https://api.x.com'"
str
डिफ़ॉल्ट:"'https://x.com/i'"
str or None
डिफ़ॉल्ट:"None"
str or None
डिफ़ॉल्ट:"None"
str or None
डिफ़ॉल्ट:"None"
Dict[str, Any] or None
डिफ़ॉल्ट:"None"
str or List[str] or None
डिफ़ॉल्ट:"None"

__init__

OAuth2 PKCE प्रमाणीकरण प्रारंभ करता है।

पैरामीटर

str
डिफ़ॉल्ट:"'https://api.x.com'"
X API टोकन endpoint के लिए base URL (https://api.x.com डिफ़ॉल्ट रूप से सेट है)।
str
डिफ़ॉल्ट:"'https://x.com/i'"
OAuth2 ऑथराइज़ेशन के लिए base URL (https://x.com/i डिफ़ॉल्ट रूप से सेट है)।
str or None
डिफ़ॉल्ट:"None"
X API के लिए client ID।
str or None
डिफ़ॉल्ट:"None"
X API के लिए client secret।
str or None
डिफ़ॉल्ट:"None"
OAuth2 ऑथराइज़ेशन के लिए redirect URI।
Dict[str, Any] or None
डिफ़ॉल्ट:"None"
मौजूदा OAuth2 token dictionary (यदि उपलब्ध हो)।
str or List[str] or None
डिफ़ॉल्ट:"None"
OAuth2 ऑथराइज़ेशन scope के लिए स्पेस से अलग की गई string या strings की सूची।

exchange_code

टोकन के लिए ऑथराइज़ेशन कोड का विनिमय करें (TypeScript API के अनुरूप)।

पैरामीटर

str
कॉलबैक से प्राप्त ऑथराइज़ेशन code।
str or None
डिफ़ॉल्ट:"None"
वैकल्पिक code verifier (यदि प्रदान नहीं किया गया है, तो संग्रहीत verifier का उपयोग किया जाता है)।

रिटर्न

Dictstr, Any

fetch_token

ऑथराइज़ेशन रिस्पॉन्स URL का उपयोग करके टोकन प्राप्त करें (लेगेसी विधि, आंतरिक रूप से exchange_code का उपयोग करती है)।

पैरामीटर

str
ऑथराइज़ेशन के बाद प्राप्त पूरा callback URL

रिटर्न

Dictstr, Any

get_authorization_url

OAuth2 PKCE flow के लिए ऑथराइज़ेशन URL प्राप्त करें।

पैरामीटर

str or None
डिफ़ॉल्ट:"None"
सुरक्षा के लिए एक वैकल्पिक state पैरामीटर।

रिटर्न

str

get_code_challenge

वर्तमान code challenge प्राप्त करता है (PKCE के लिए)। :returns: वर्तमान code challenge, या सेट न होने पर None। :rtype: Optional[str]

रिटर्न

str | None

get_code_verifier

वर्तमान code verifier लौटाता है (PKCE के लिए)। :returns: वर्तमान code verifier, या यदि यह सेट न हो तो None। :rtype: Optional[str]

रिटर्न

str | None

is_token_expired

जांचें कि टोकन की समय-सीमा समाप्त हो चुकी है या नहीं। :returns: यदि टोकन की समय-सीमा समाप्त हो चुकी है, तो True; अन्यथा False। :rtype: bool

रिटर्न

bool

refresh_token

एक्सेस टोकन को रीफ़्रेश करता है। :returns: रीफ़्रेश किया गया टोकन डिक्शनरी :rtype: Dict[str, Any]

रिटर्न

Dictstr, Any

set_pkce_parameters

PKCE पैरामीटर को मैन्युअली सेट करें।

पैरामीटर

str
इस्तेमाल किया जाने वाला code verifier.
str or None
डिफ़ॉल्ट:"None"
वैकल्पिक code challenge (अगर नहीं दिया गया है, तो इसे जनरेट किया जाएगा)।