مین مواد پر جائیں

API key

API key اس ڈویلپر اکاؤنٹ کی شناخت کرتی ہے جو GVR ڈویلپر APIs کو درخواست بھیج رہا ہو۔

اپنی key کا انتظام​

GVR ایپلیکیشن سے اپنی API key بنائیں، دیکھیں، تبدیل کریں یا حذف کریں۔ یہ دستاویزات صرف اکاؤنٹ میں key دستیاب ہونے کے بعد اس کے استعمال کا طریقہ بتاتی ہیں۔

key استعمال کریں​

اپنی key کو apiKey درخواست ہیڈر کے ذریعے ڈویلپر اینڈپوائنٹس پر بھیجیں:

apiKey: YOUR_API_KEY

JSON درخواستوں میں JSON کا معمول کا content type بھی شامل کریں:

Content-Type: application/json
apiKey: YOUR_API_KEY

فائل اپ لوڈ کے لیے multipart form درخواست کے ساتھ key بھیجیں۔

key کا دورانیہ​

اگر GVR ایپلیکیشن میں key تبدیل یا حذف کر دی جائے تو پرانی key استعمال کرنے والی درخواست ناکام ہو گی:

{
  "error": "Invalid API key"
}

سیکیورٹی نوٹس​

  • keys کو سرور سائیڈ ماحول کی متغیرات میں محفوظ کریں۔
  • keys کو کوڈ repository میں شامل نہ کریں۔
  • keys کو عوامی فرنٹ اینڈ بنڈلز میں ظاہر نہ کریں۔
  • key غلطی سے شیئر ہو جائے تو GVR ایپلیکیشن سے اسے تبدیل کریں۔