एपीआई कुंजी किसी एपीआई द्वारा जारी किया जाने वाला सबसे सरल क्रेडेंशियल है: यह एक लंबी, यादृच्छिक स्ट्रिंग होती है जो किसी खाते या प्रोजेक्ट से जुड़ी होती है और प्रत्येक अनुरोध के साथ भेजी जाती है — आमतौर पर X-API-Key जैसे हेडर में, कभी-कभी क्वेरी स्ट्रिंग में। यह बिलिंग, कोटा और एक्सेस कंट्रोल के लिए कॉल करने वाले व्यक्ति की पहचान करती है, लेकिन सर्वर द्वारा निर्धारित किए जाने तक इसकी कोई समय सीमा या दायरा नहीं होता है।
सर्वर प्रत्येक अनुरोध पर कुंजी की जाँच करता है, अज्ञात अनुरोधों को 401 त्रुटि संदेश के साथ अस्वीकार कर देता है और उस कुंजी के कोटा और अनुमतियों को लागू करता है। कुंजियाँ आमतौर पर डैशबोर्ड में बनाई जाती हैं, पुरानी कुंजी को निरस्त करने से पहले नई कुंजी जारी करके इन्हें बदला जा सकता है, और अक्सर ये विशिष्ट आईपी श्रेणियों, संदर्भकर्ताओं या अंतिम बिंदुओं तक ही सीमित होती हैं।
क्वेरी स्ट्रिंग में कुंजी उतनी ही सुरक्षित होती है जितनी कि हेडर में। यूआरएल सर्वर लॉग, प्रॉक्सी लॉग और ब्राउज़र इतिहास में लिखे जाते हैं और रेफरर हेडर के माध्यम से लीक हो सकते हैं; हेडर भी पूरी तरह से गुप्त नहीं होता, लेकिन यह इतनी अधिक जगहों पर नहीं पहुंचता।
कार्गो ट्रैकिंग एपीआई को अपने राइट्स (POST /cargo/v1/shipments और स्टेट-मशीन ट्रांजिशन के लिए X-API-Key की आवश्यकता होती है, जबकि इसके रीड्स ओपन होते हैं, इसलिए एक ही एपीआई दोनों पक्षों को दिखाता है।
सभी शब्द · परीक्षण तकनीकें · सभी 39 मॉक REST API
आखरी अपडेट