मुख्य सामग्री पर जाएं

API कुंजी प्रमाणीकरण

सभी API अनुरोधों के लिए X-API-Key हेडर में API कुंजी पास करना आवश्यक है।

API कुंजी प्राप्त करना

  1. tronrental.com पर साइन अप करें
  2. डैशबोर्ड → API Keys पर जाएं
  3. API कुंजी बनाएं पर क्लिक करें
  4. अपनी कुंजी कॉपी करें और सुरक्षित रूप से स्टोर करें — यह केवल एक बार दिखाई जाती है

IP व्हाइटलिस्ट (वैकल्पिक)

अतिरिक्त सुरक्षा के लिए आप अपनी API कुंजी को विशिष्ट IP एड्रेस तक सीमित कर सकते हैं। कुंजी बनाते या संपादित करते समय डैशबोर्ड में यह कॉन्फ़िगर करें।

कुंजी अनुमतियां

हर API कुंजी के साथ स्कोप (scopes) होते हैं — वे ऑपरेशन जो वह कर सकती है। कुंजी बनाते या संपादित करते समय आप उन्हें डैशबोर्ड में चुनते हैं। नई कुंजी को पढ़ने और लिखने के सभी स्कोप मिलते हैं (एनर्जी और बैंडविड्थ खरीदना, Smart Mode, बैलेंस और इतिहास देखना आदि), सिवाय withdraw के: यह स्कोप अलग से चालू किया जाता है और इसके लिए 2FA और IP व्हाइटलिस्ट ज़रूरी हैं। कुंजी के स्कोप से बाहर का अनुरोध HTTP 403 के साथ अस्वीकार होता है। पूरी सूची: API कुंजी स्कोप की सूची।
अपनी API कुंजी को गोपनीय रखें। इसे क्लाइंट-साइड कोड, सार्वजनिक रिपॉजिटरी या URL में एक्सपोज़ न करें।

Node API कुंजियाँ

Node API — node.tronrental.com पर TRON फ़ुल नोड्स तक पहुँच — की अपनी अलग कुंजियाँ होती हैं। आप उन्हें डैशबोर्ड → Node API में एंडपॉइंट के रूप में बनाते हैं। Node API कुंजी केवल नोड पर काम करती है: यह API उसका जवाब 403 NODE_API_KEY_ONLY से देता है। इस पेज पर बताई गई API कुंजियाँ भी नोड पर काम नहीं करतीं। देखें Node API → एंडपॉइंट और कुंजियाँ।

कुंजी उपयोग और अनुरोध लॉग

API कुंजी से प्रमाणित हर अनुरोध 7 दिनों तक रखा जाता है: मेथड, पाथ, स्टेटस कोड, लेटेंसी और क्लाइंट IP। क्वेरी पैरामीटर इस दृश्य में नहीं दिखाए जाते। Dashboard → API Keys खोलें और किसी कुंजी को विस्तृत करके उसके हाल के अनुरोध देखें; Last Used कॉलम सबसे हालिया कॉल दिखाता है (प्रमाणीकरण का निशान अधिकतम हर 5 मिनट में एक बार अपडेट होता है, अनुरोध लॉग सटीक है)। लॉग केवल डैशबोर्ड से उपलब्ध है — API कुंजी अपना लॉग नहीं पढ़ सकती।

रेट लिमिट

रेट लिमिट प्रति कुंजी नहीं, प्रति खाता गिनी जाती है: एक ही खाते की सभी कुंजियां एक ही बजट साझा करती हैं। विवरण के लिए रेट लिमिट देखें।

त्रुटियां

प्रमाणीकरण त्रुटियां HTTP 401 लौटाती हैं:
यदि आपकी कुंजी अक्षम या ब्लॉक है, तो आपको HTTP 403 प्राप्त होगा।