इसे छोड़कर कंटेंट पर जाएं

प्रमाणीकरण और API कुंजियाँ

API केंद्र में sk_ API कुंजी बनाएँ। पूरी कुंजी केवल एक बार, जब इसे बनाया या रोटेट किया जाता है, तो दिखाई जाती है।

प्रत्येक एप्लिकेशन, वातावरण और स्वचालित कार्य के लिए एक अलग कुंजी का उपयोग करें, ताकि प्रत्येक का अपना बजट हो सके और इसे अपने आप अक्षम, रोटेट और ऑडिट किया जा सके।

शिक्षाप्रद जानकारी भेजें

Section titled “शिक्षाप्रद जानकारी भेजें”

अनुशंसित:

X-API-Key: sk_your_key

मानक Bearer फ़ॉर्म भी काम करता है:

Authorization: Bearer sk_your_key

कृपया अनुरोध में इनमें से केवल एक ही भेजें।

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

एक कुंजी का प्रतिनिधित्व क्या करती है

Section titled “एक कुंजी का प्रतिनिधित्व क्या करती है”

एक कुंजी उस खाते के लिए कार्य करती है जिसने इसे बनाया है: यह उन सेवाओं को कॉल कर सकती है जिनका उपयोग वह खाता कर सकता है और केवल उस खाते के संसाधनों तक पहुँच सकती है। एक कुंजी प्रवेश ईमेल, पासवर्ड, फ़ोन नंबर या प्रोफ़ाइल को बदल नहीं सकती है, और न ही API कुंजियों को बना, घूमना या रद्द कर सकती है।

वैकल्पिक सीमाएँ:

  • allowed_engines: केवल सूचीबद्ध अनुवाद सेटिंग्स; एक खाली ऐरे किसी भी कुंजी-स्तरीय सीमा को नहीं जोड़ता।
  • expires_at: समाप्ति समय।
  • quota_limit: कुंजी का जीवनकाल बजट पूर्ण मिलीक्रेडिट में; 0 कुंजी-स्तरीय बजट निर्धारित नहीं करता है, और खाते के क्रेडिट सामान्य रूप से निपटाए जाते हैं।

घुमाएं और रद्द करें

Section titled “घुमाएं और रद्द करें”

API केंद्र में कुंजियाँ बनाएँ, उनकी सीमाओं को बदलें, उन्हें रोटेट करें या रद्द करें। एक बार कुंजी रद्द, अक्षम या समाप्त हो जाने पर, या उसका खाता अक्षम हो जाने पर, नए अनुरोध तुरंत विफल हो जाते हैं।

रोटेशन से एक नया सीक्रेट बनता है और पुराने को तुरंत अक्षम कर दिया जाता है; नया की ओर से मूल सीमाएँ और पहले से उपयोग किए गए बजट को बरकरार रखा जाता है। समाप्त हो चुके की को रोटेट नहीं किया जा सकता; इसके लिए नया की बनाएँ। सुचारू स्विच के लिए, नया की बनाएँ और उसे डिप्लॉय करें, पुष्टि करें कि कॉल सफल हो रहे हैं, फिर पुरानी की को रद्द करें।

  • कीज़ को केवल सर्वर पर या नियंत्रित रनटाइम में रखें।
  • पर्यावरण चरों या सीक्रेट मैनेजर का उपयोग करें; कभी भी कुंजियों को स्रोत कोड, लॉग, ब्राउज़र बंडल या सार्वजनिक रिपॉज़िटरी में न डालें।
  • API द्वारा लौटाए गए अपलोड या डाउनलोड पतों के लिए कभी भी कुंजी न भेजें।
  • कीज़ आईडी, रिक्वेस्ट आईडी और ऑपरेशन आईडी को लॉग करें; पूरी कीज़ को कभी भी लॉग न करें।
  • यदि कोई कुंजी लीक होती है, तो उसे तुरंत बदलें और उसके कार्यों एवं चार्जों की समीक्षा करें।