BroadRouter
شروع کریں

API کلید (API key)

اپ ڈیٹ

API کلید ایک خفیہ اسٹرنگ ہے جو API کال کرنے والے کلائنٹ کی شناخت کرتی اور اسے اجازت دیتی ہے۔ LLM API عموماً اسے Authorization: Bearer ہیڈر میں چاہتے ہیں، اور جس کے پاس بھی یہ کلید ہو وہ ایسی درخواستیں کر سکتا ہے جن کا بل کلید والے اکاؤنٹ پر بنتا ہے۔

دوسرے نام: API کلید، API کی، خفیہ کلید، api key kya hai، api key kaise banaye، API key، API token، secret key، bearer token، inference key

API کلید کسی پروگرام کے لیے پاس ورڈ کی طرح کام کرتی ہے۔ یہ خرچ کرنے کا اختیار بھی ہے: جس کے پاس یہ ہو، وہ آپ کا بیلنس استعمال کر سکتا ہے۔

یہ کیسے کام کرتی ہے

LLM API کلید کو 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 tokens ہمیشہ TLS (https://) پر ہی بھیجیں۔

فراہم کنندہ کلید تلاش کرتا ہے، اکاؤنٹ پہچانتا ہے، حدیں اور پالیسیاں جانچتا ہے، اور پھر درخواست پوری کرتا یا رد کرتا ہے۔ کلید نہ ہو یا غلط ہو تو عموماً 401 آتا ہے؛ اگر کوئی پالیسی، جیسے IP allow list، کلید کو رد کرے تو عموماً 403۔

یہ کیوں اہم ہے

لیک ہوئی کلید API بل بے قابو ہونے کی سب سے عام وجوہات میں سے ہے، کیونکہ بوٹس عوامی کوڈ میں خفیہ معلومات ڈھونڈتے رہتے ہیں۔ اگر کلید ایسے اینڈپوائنٹس تک پہنچے جو اکاؤنٹ کی تفصیلات لوٹاتے ہیں تو ڈیٹا بھی ظاہر ہو سکتا ہے۔ OWASP کی secrets رہنمائی کے مطابق اچھے طریقے:

  • کلیدیں انوائرنمنٹ ویری ایبلز یا secrets manager سے لوڈ کریں۔ انہیں کبھی commit نہ کریں یا کنٹینر امیجز میں شامل نہ کریں۔
  • ہر ایپ یا ایجنٹ کو اس کی اپنی کلید دیں، تاکہ سب کچھ روکے بغیر ایک کو منسوخ کر سکیں۔
  • کلیدیں مقررہ وقفوں پر بدلیں، اور لیک کا شبہ ہوتے ہی فوراً۔
  • کلید کہاں چلے، یہ محدود کریں، مثلاً سرور IPs کی allow list سے۔

BroadNet Inference پر

BroadNet دو اسناد الگ رکھتا ہے۔ انفرنس کلید /v1/* پر ماڈلز کال کرتی ہے۔ پورٹل کریڈینشل اکاؤنٹ کو خودکار بناتا ہے: کلیدیں، اجازت یافتہ IPs اور خریداریاں۔ دوسرے کو اکاؤنٹ کا مکمل اختیار سمجھیں۔

دونوں صرف ایک بار دکھائے جاتے ہیں۔ BroadNet صرف SHA-256 ہیش رکھتا ہے، اس لیے وہ کلید دوبارہ نہیں دکھا سکتا۔ استعمال کے مطابق ادائیگی والی کلید ایک سال چلتی ہے، اور ایک اکاؤنٹ میں زیادہ سے زیادہ دس فعال کلیدیں ہو سکتی ہیں۔ ہر کلید کے ساتھ اجازت یافتہ IPs کی اپنی فہرست ہو سکتی ہے۔ کلید منسوخ کرنے یا allow-list بدلنے کے بعد پانچ سیکنڈ کے اندر نئی درخواستیں رک جاتی ہیں۔

مقررہ قیمت والے پلانز کی پلان کلیدیں الگ ہوتی ہیں اور کبھی آپ کے بیلنس سے نہیں کٹتیں۔ سیٹ اپ کے مراحل API کلیدیں اور IP allow lists میں ہیں، اور اسٹیٹس کوڈز ایررز اور دوبارہ کوشش میں۔

عام غلطیاں

  • پورے ریکویسٹ ہیڈرز لاگ کرنا۔ اس سے کلید آپ کے لاگز میں لکھی جاتی ہے۔
  • پوری ٹیم میں ایک ہی کلید بانٹنا۔ تب آپ کسی ایک شخص کی رسائی منسوخ نہیں کر سکتے۔
  • سپورٹ کو کلید بھیجنا۔ اس کے بجائے X-Request-ID ہیڈر کی قدر بھیجیں۔

عام سوالات

کیا LLM API کلید براؤزر یا موبائل ایپ میں رکھی جا سکتی ہے؟

نہیں۔ کلائنٹ تک بھیجی گئی ہر چیز نکالی جا سکتی ہے۔ کلید سرور پر رکھیں، اور آپ کی ایپ آپ کے سرور کو کال کرے، جو پھر LLM API کو کال کرے۔

اگر کلید لیک ہو جائے تو کیا کروں؟

اسے فوراً منسوخ کریں، نئی کلید بنائیں، اور جتنی دیر وہ کھلی رہی اتنے عرصے کا استعمال جانچیں۔ پھر معلوم کریں کہ وہ کیسے لیک ہوئی، مثلاً کسی commit، لاگ لائن یا اسکرین شاٹ سے۔

BroadNet Inference پر میری کتنی کلیدیں ہو سکتی ہیں؟

ہر اکاؤنٹ پر استعمال کے مطابق ادائیگی والی زیادہ سے زیادہ دس فعال کلیدیں۔ ہر کلید بننے سے ایک سال تک چلتی ہے۔ پلان کی کلیدیں الگ ہوتی ہیں۔

Markdown میں پڑھیںChatGPT سے پوچھیںClaude سے پوچھیںPerplexity سے پوچھیں