मुख्य कंटेंट तक स्किप करें

API कुंजी

API कुंजी उस डेवलपर खाते की पहचान करती है जो GVR डेवलपर API को अनुरोध भेजता है।

अपनी कुंजी प्रबंधित करें​

GVR ऐप्लिकेशन से API कुंजी बनाएँ, देखें, बदलें या हटाएँ। यह दस्तावेज़ बताता है कि खाता में कुंजी उपलब्ध होने के बाद उसका उपयोग कैसे करें।

कुंजी का उपयोग करें​

डेवलपर एंडपॉइंट को अनुरोध भेजते समय apiKey हेडर में अपनी कुंजी शामिल करें:

apiKey: YOUR_API_KEY

JSON अनुरोधों में JSON Content-Type भी शामिल करें:

Content-Type: application/json
apiKey: YOUR_API_KEY

फ़ाइल अपलोड के लिए multipart फ़ॉर्म अनुरोध के साथ कुंजी भेजें।

कुंजी का जीवनचक्र​

GVR ऐप्लिकेशन में कुंजी बदलने या हटाने पर पुरानी कुंजी वाले अनुरोध इस त्रुटि के साथ विफल होंगे:

{
  "error": "Invalid API key"
}

सुरक्षा संबंधी नोट्स​

  • कुंजियों को सर्वर-साइड environment variables में रखें।
  • कुंजियों को रिपॉज़िटरी में कमिट न करें।
  • सार्वजनिक फ़्रंटएंड बंडल में कुंजियाँ उजागर न करें।
  • कुंजी गलती से साझा हो जाए तो GVR ऐप्लिकेशन से उसे बदल दें।