跳转到内容

प्रमाणीकरण आणि API कीज

API केंद्र मध्ये sk_ API की तयार करा. संपूर्ण की फक्त एकदाच, जेव्हा ती तयार केली जाते किंवा रोटेट केली जाते तेव्हा दर्शवली जाते.

प्रत्येक अनुप्रयोग, वातावरण आणि स्वयंचलित कार्यासाठी स्वतंत्र की वापरा, जेणेकरून प्रत्येकाला स्वतःचे बजेट असू शकेल आणि ते स्वतंत्रपणे अक्षम केले, फिरवले आणि ऑडिट केले जाऊ शकेल.

शिफारस केलेली:

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 केंद्रात कीज तयार करा, त्यांची मर्यादा बदला, त्यांचे रोटेशन करा किंवा त्यांना रद्द करा . एकदा कीज रद्द केली, अक्षम केली किंवा मुदत संपली किंवा त्याचे खाते अक्षम केले गेले, तर नवीन विनंत्या तात्काळ अयशस्वी होतात.

रोटेशनमुळे एक नवीन सिक्रेट तयार होते आणि जुना सिक्रेट त्वरित अक्षम केला जातो; नवीन की मूळ मर्यादा आणि आधीच वापरलेले बजेट कायम ठेवते. कालबाह्य झालेल्या कीचे रोटेशन करता येत नाही; त्याऐवजी नवीन की तयार करा. सुरळीत स्विचसाठी, नवीन की तयार करा आणि ती डेप्लॉय करा, कॉल्स यशस्वी होतात याची पुष्टी करा, त्यानंतर जुनी की रद्द करा.

  • की फक्त सर्व्हरवर किंवा नियंत्रित रनटाइममध्ये ठेवा.
  • पर्यावरण च biếnा किंवा सीक्रेट मॅनेजरचा वापर करा; कधीही कीज सोर्स कोड, लॉग, ब्राउझर बंडल किंवा सार्वजनिक रिपॉझिटरीमध्ये ठेवू नका.
  • API द्वारे परत केलेल्या अपलोड किंवा डाउनलोड पत्त्यांवर कधीही की पाठवू नका.
  • की आयडी, विनंती आयडी आणि ऑपरेशन आयडी लॉग करा; पूर्ण की कधीही लॉग करू नका.
  • जर एखादी की लीक झाली, तर त्वरितपणे ती बदला आणि तिची कार्ये आणि शुल्क पुन्हा तपासा.