API key
API key एक लंबी रैंडम स्ट्रिंग है जिससे सर्विस पहचानती है कि request किसने भेजी: अकाउंट किसका है, कौन-से प्लान पर है और कौन-सा डेटा पा सकता है। प्रोग्राम के लिए key पासवर्ड की तरह काम करती है: जो स्ट्रिंग जानता है, वह मालिक की ओर से काम करता है।
key कैसे भेजी जाती है
key हर request के हेडर में जाती है, जबकि फ़िल्टर URL में रहते हैं। Genesis API में हेडर X-API-Key है और key gns_live_… जैसी दिखती है। उदाहरण AI Signals से alpha ग्रेड वाले सिग्नल माँगता है:
import os
import requests
key = os.environ.get("GENESIS_API_KEY")
if not key:
raise SystemExit("सर्वर पर GENESIS_API_KEY सेट करें")
r = requests.get(
"https://api.genesisarbitrage.com/v1/ai/signals",
headers={"X-API-Key": key}, # key सिर्फ़ हेडर में
params={"category": "alpha"}, # फ़िल्टर URL में
timeout=10,
)
if r.status_code == 401:
# key नहीं है, ग़लत है या रद्द हो चुकी है
print(r.json()["error"]["code"]) # invalid_key
elif r.ok:
print("alpha सिग्नल:", r.json()["meta"]["count"])
हेडर इसलिए इस्तेमाल होता है कि request का URL, query string समेत, वेब सर्वर और प्रॉक्सी के लॉग में रह जाता है, और अगर कोई उसे ब्राउज़र में खोले तो ब्राउज़र इतिहास में भी। Genesis API का डॉक्यूमेंटेशन साफ़ कहता है: key को query पैरामीटर में न भेजें, वेबसाइट या ऐप के कोड में न डालें, और request सिर्फ़ अपने सर्वर से करें। एक्सचेंज भी ऐसे ही काम करते हैं: Binance key X-MBX-APIKEY हेडर में लेता है, और अकाउंट की request दूसरी key, यानी API secret, से signed भी होती हैं।
key को कैसे रखें
- key को सर्वर पर environment variable या
.envफ़ाइल में रखें, और.envको.gitignoreमें जोड़ें। - key को कभी वेबसाइट के कोड, मोबाइल ऐप, चैट या स्क्रीनशॉट में न डालें।
- Genesis API key एक बार दिखाता है और सिर्फ़ उसका hash रखता है: खोई key वापस नहीं मिलती, सिर्फ़ दोबारा जारी होती है।
- key लीक हो जाए तो प्रोफ़ाइल में "Reissue" दबाएँ, पुरानी key तुरंत बंद हो जाती है। "Revoke" key को बिना बदले बंद कर देता है।
एक्सचेंज key बनाम Genesis API key
| एक्सचेंज key | Genesis API key | |
|---|---|---|
| अधिकार | पढ़ना, ट्रेड, निकासी: जो आप चालू करें | सिर्फ़ डेटा पढ़ना |
| लीक होने पर खुलता है | आपके अकाउंट के ट्रेड और निकासी | आपका calls का कोटा |
| सुरक्षा | निकासी बंद, IP whitelist | प्रोफ़ाइल में reissue |
Genesis API की key सिर्फ़ पढ़ने वाली है: वह ऑर्डर नहीं लगा सकती और पैसे नहीं निकाल सकती। key की त्रुटियाँ और उनके कोड ऑथेंटिकेशन और एरर सेक्शन में हैं।
यह भी देखें: API, endpoint, rate limit, API key: पाना, रखना, reissue और revoke करना।
सवाल और जवाब
क्या मैं कई Genesis API key बना सकता हूँ?
नहीं, एक अकाउंट की एक key होती है। "Reissue" नई key देता है और पुरानी को तुरंत बंद कर देता है।
Genesis API key कहाँ से मिलती है?
प्रोफ़ाइल में, "Genesis API" ब्लॉक में, API प्लान का भुगतान करने के बाद। "key पाएँ" बटन "आपकी API key" विंडो खोलता है, जिसमें "कॉपी" बटन है।