BroadRouter
शुरू करें

API key

अपडेट किया गया

API key एक गुप्त स्ट्रिंग है जो API कॉल करने वाले क्लाइंट को पहचानती और अधिकृत करती है। LLM API आम तौर पर इसे Authorization: Bearer हेडर में चाहते हैं, और जिसके पास भी यह key हो, वह ऐसे अनुरोध कर सकता है जिनका बिल key वाले अकाउंट पर बनता है।

अन्य नाम: API key क्या है, सीक्रेट key, api key kya hai, api key kaise banaye, API key, API token, secret key, bearer token, inference key

API key किसी प्रोग्राम के लिए पासवर्ड की तरह काम करती है। यह ख़र्च करने का अधिकार भी है: जिसके पास यह है, वह आपका बैलेंस इस्तेमाल कर सकता है।

यह कैसे काम करती है

LLM API, key को bearer token मानते हैं। क्लाइंट इसे हर अनुरोध के साथ भेजता है:

curl https://inference.broadnet.ai/v1/models \
  -H "Authorization: Bearer $BROADNET_API_KEY"

RFC 6750 bearer token की परिभाषा ऐसे टोकन के रूप में देता है जिसे “any party in possession of the token” (अनुवाद: टोकन रखने वाला कोई भी पक्ष) इस्तेमाल कर सकता है। कोई दूसरा फ़ैक्टर नहीं होता। इसीलिए यही RFC कहता है कि क्लाइंट bearer token हमेशा TLS (https://) पर ही भेजें।

प्रोवाइडर key खोजता है, अकाउंट पहचानता है, लिमिट और पॉलिसी जाँचता है, और फिर अनुरोध पूरा करता है या ठुकराता है। key न हो या ग़लत हो तो आम तौर पर 401 आता है; अगर पॉलिसी, जैसे IP allow list, key को ठुकराए, तो आम तौर पर 403।

यह क्यों मायने रखती है

लीक हुई key API बिल बेक़ाबू होने की सबसे आम वजहों में से है, क्योंकि बॉट पब्लिक कोड में सीक्रेट खोजते रहते हैं। अगर key ऐसे एंडपॉइंट तक पहुँचती है जो अकाउंट की जानकारी लौटाते हैं, तो डेटा भी उजागर हो सकता है। OWASP की सीक्रेट गाइडेंस के मुताबिक़ अच्छे तरीक़े:

  • key को एनवायरनमेंट वेरिएबल या सीक्रेट मैनेजर से लोड करें। इन्हें कभी commit न करें या कंटेनर इमेज में न डालें।
  • हर ऐप या एजेंट को उसकी अपनी key दें, ताकि सब कुछ रोके बिना एक को रद्द कर सकें।
  • key तय समय पर बदलें, और लीक का शक होते ही तुरंत।
  • key कहाँ चले, यह सीमित करें, जैसे सर्वर IP की allow list से।

BroadNet Inference पर

BroadNet दो क्रेडेंशियल अलग रखता है। इन्फ़रेंस key /v1/* पर मॉडल कॉल करती है। पोर्टल क्रेडेंशियल अकाउंट को ऑटोमेट करता है: key, अनुमत IP और ख़रीदारी। दूसरे वाले को अकाउंट का पूरा अधिकार मानें।

दोनों सिर्फ़ एक बार दिखाए जाते हैं। BroadNet सिर्फ़ SHA-256 हैश रखता है, इसलिए वह key दोबारा नहीं दिखा सकता। उपयोग के अनुसार भुगतान वाली key एक साल चलती है, और एक अकाउंट में अधिकतम दस चालू key हो सकती हैं। हर key के साथ अनुमत IP की अपनी सूची हो सकती है। key रद्द करने या allow-list बदलने के बाद पाँच सेकंड के अंदर नए अनुरोध रुक जाते हैं।

फ़्लैट-रेट प्लान की प्लान key अलग होती हैं और कभी आपके बैलेंस से नहीं कटतीं। सेटअप के क़दम API key और IP allow list में हैं, और स्टेटस कोड एरर और रीट्राई में।

आम ग़लतियाँ

  • पूरे रिक्वेस्ट हेडर लॉग करना। इससे key आपके लॉग में लिख जाती है।
  • पूरी टीम में एक ही key बाँटना। तब आप किसी एक व्यक्ति की पहुँच रद्द नहीं कर सकते।
  • सपोर्ट को key भेजना। उसकी जगह X-Request-ID हेडर की वैल्यू भेजें।

अक्सर पूछे जाने वाले सवाल

क्या LLM API key को ब्राउज़र या मोबाइल ऐप में रख सकते हैं?

नहीं। क्लाइंट तक भेजी गई हर चीज़ निकाली जा सकती है। key को सर्वर पर रखें, और अपना ऐप अपने सर्वर को कॉल करे, जो फिर LLM API को कॉल करे।

अगर key लीक हो जाए तो क्या करूँ?

उसे तुरंत रद्द करें, नई key बनाएँ, और जितने समय वह खुली रही, उतने समय का इस्तेमाल जाँचें। फिर पता लगाएँ कि वह कैसे लीक हुई, जैसे किसी commit, लॉग लाइन या स्क्रीनशॉट से।

BroadNet Inference पर मेरी कितनी key हो सकती हैं?

हर अकाउंट पर उपयोग के अनुसार भुगतान वाली अधिकतम दस चालू key। हर key बनने से एक साल तक चलती है। प्लान की key अलग होती हैं।

Markdown में पढ़ेंChatGPT से पूछेंClaude से पूछेंPerplexity से पूछें