API کلیدیں (Developers صفحہ)

🌐 یہ ترجمہ کمیونٹی نظرثانی کے تحت ہے۔ کوئی غلطی یا غیر فطری انداز نظر آیا؟ نیچے اس صفحے کو GitHub پر ایڈٹ کریں پر کلک کر کے بہتری تجویز کریں۔

اگر آپ Quran Gallery پر کچھ بنا رہے ہیں — سائڈ پراجیکٹ، ذاتی ڈیش بورڈ، آٹومیشن اسکرپٹ — تو آپ ذاتی API کلیدیں بنا سکتے ہیں جو ثابت کرتی ہیں کہ درخواست آپ کی طرف سے ہے، بغیر براؤزر سیشن کے۔

API کلیدیں مکمل طور پر آپ کے اکاؤنٹ میں Developers صفحے سے منظم ہوتی ہیں۔

Developers صفحے تک کیسے پہنچیں

accounts.qurangallery.com پر سائن اِن کریں، پھر accounts.qurangallery.com/developers جائیں۔ کئی مینوز اس سے براہ راست لنک ہیں۔

API کلید کیا ہے

ایک API کلید لمبا خفیہ سٹرنگ ہے جیسا:

qg_abc123def456...

qg_ پری فکس اسے Quran Gallery کلید کے طور پر چنتا ہے۔ جب آپ اسے Quran Gallery پر درخواست کے Authorization: Bearer ... ہیڈر میں بھیجتے ہیں، سرور درخواست کو ایسے سمجھتا ہے جیسے آپ نے کی۔ پس API کلید کسی طرح آپ کے اکاؤنٹ کا پاس ورڈ ہے جو پروگرامیٹک استعمال کے لیے مخصوص — اسے ایک کی طرح برتاؤ کریں۔

کلید بنانا

1. Developers صفحے پر Create New Key کارڈ تلاش کریں۔
2. ایک وضاحتی نام ٹائپ کریں — "Madrasah progress export script"، "My Raspberry Pi dashboard"، "Local dev"۔ نام صرف آپ کے لیے ہے — کلید کی لسٹ میں دکھتا ہے۔
3. Create key کلک کریں۔

نئی کلید صفحے کے اوپر سبز کارڈ میں اپنی پوری قیمت کے ساتھ ظاہر ہوتی ہے۔ یہی واحد بار ہے جب آپ پوری کلید دیکھیں گے۔ کاپی آئیکن دبا کر اسے کلپ بورڈ میں رکھیں، پھر محفوظ جگہ سٹور کریں: پاس ورڈ مینیجر، کلاؤڈ سیکریٹ مینیجر، ورژن کنٹرول سے باہر .env فائل۔

Done دبانے کے بعد، سبز کارڈ غائب ہو جاتا ہے، اور اس لمحے سے کلید کے صرف پہلے چند حروف (“start”) دکھائی دیتے ہیں۔ پوری قیمت دوبارہ حاصل کرنے کا کوئی طریقہ نہیں — کھو دینے پر نئی بنا کر پرانی ڈیلیٹ کرنی پڑے گی۔

کلیدوں کی فہرست

Create فارم کے نیچے، آپ کے اکاؤنٹ پر موجود ہر کلید دکھتی ہے۔

ہر کلید کے لیے:

• نام — جو آپ نے بناتے وقت لکھا۔
• اسٹیٹس — Active (سبز پل) یا Disabled (گرے پل)۔
• Start — کلید کے پہلے چند حروف، جیسے qg_abc12...۔ راز ظاہر کیے بغیر شناخت کرنے کے لیے کافی۔
• Created — کلید کی تخلیق کی تاریخ۔

ہر قطار کے دائیں طرف، ٹریش آئیکن کلید کو ڈیلیٹ کرتا ہے۔ ڈیلیٹ مستقل اور فوری ہے — ڈیلیٹ کی گئی کلید استعمال کرتا ہر اسکرپٹ اگلی درخواست پر 401 پانا شروع کرتا ہے۔

کلید استعمال

اسے Authorization ہیڈر میں بھیجیں:

Authorization: Bearer qg_abc123def456...

Developers صفحے پر استعمال کارڈ کاپی کرنے کے لیے درست فارمیٹ دکھاتا ہے۔ ایک ہی کلید Quran Gallery کی تمام خدمات میں کام کرتی ہے جو کلید کی توثیق سپورٹ کرتی ہیں۔

API-key درخواستیں براؤزر سیشن کو نظرانداز کرتی ہیں، تو آپ CI جاب، طے شدہ کاموں، موبائل ایپس میں استعمال کر سکتے ہیں۔

ریٹ لمٹس

ہر API کلید 60 درخواستیں فی منٹ پر محدود، سلائیڈنگ ونڈو۔ ذاتی استعمال اور زیادہ تر اسکرپٹس کے لیے کافی۔ تجاوز کرنے پر API HTTP 429 اور ہیڈرز واپس کرتا ہے۔ انتظار کریں، پھر دوبارہ شروع۔

نیست اور حذف شدہ اکاؤنٹس کی API کلیدیں فوراً کام کرنا چھوڑ دیتی ہیں۔

کلیدیں روٹیٹ کرنا

بہترین مشق ہے روٹیٹ کرنا جب کبھی:

• کلید کے ساتھ لیپ ٹاپ یا ڈیوائس کھو گیا یا بیچا گیا۔
• آپ نے کلید کسی ساتھی کے ساتھ شیئر کی جسے اب رسائی نہیں چاہیے۔
• کافی وقت گزر گیا اور آپ نہیں چاہتے کہ کوئی غیر-روٹیٹڈ راز پڑا ہو۔

روٹیشن دو-قدمی دستی پروسس ہے:

1. وضاحتی نام کے ساتھ نئی کلید بنائیں۔
2. اپنے اسکرپٹس/ایپس کو نئی کلید استعمال کرنے کے لیے اپ ڈیٹ کریں۔
3. سب کچھ نئی کلید پر آ جانے کے بعد، پرانی ڈیلیٹ کر دیں۔

آٹومیٹڈ روٹیشن فیچر آج نہیں ہے۔

میں اپنی کلید کھو دی

Quran Gallery کھوئی ہوئی کلید بازیافت نہیں کر سکتا — تخلیق کے بعد ہم صرف ہیش سٹور کرتے ہیں۔ پرانی کلید لسٹ سے ڈیلیٹ کریں (تاکہ اگر کسی اور کے پاس ہو تو کام چھوڑ دے) اور نئی بنائیں۔ اپنا اسکرپٹ نئی قیمت استعمال کرنے کے لیے اپ ڈیٹ کریں۔

سکیورٹی چیک لسٹ

• کلید کبھی git پر کمٹ نہ کریں۔ .env فائل (اور اسے .gitignore میں شامل) یا اپنا پلیٹ فارم سیکریٹ مینیجر استعمال کریں۔
• کلید کبھی پبلک Slack، Discord، GitHub، یا AI ٹول چیٹ میں پیسٹ نہ کریں۔ کلیدیں بالکل پاس ورڈ کی طرح ٹریٹ کریں۔
• ہر پراجیکٹ کے لیے ایک کلید استعمال کریں، ہر چیز کے لیے ایک نہیں۔
• اگر کلید کا کمپرومائز کا شبہ ہو، پہلے ڈیلیٹ کریں، پھر نئی بنائیں۔ ترتیب اہم ہے۔
• کلائنٹ سائڈ کوڈ میں کلیدیں بیک نہ کریں (براؤزر میں چلنے والی JavaScript، موبائل-ایپ بائنریز)۔

عام ایرر