跳转到内容

പ്രാമാണീകരണവും API കീകളും

ഒരു കീ സൃഷ്ടിക്കുക

Section titled “ഒരു കീ സൃഷ്ടിക്കുക”

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 നൽകുന്ന വിലാസങ്ങൾ അപ്‌ലോഡ് ചെയ്യാനോ ഡൗൺലോഡ് ചെയ്യാനോ ഒരിക്കലും കീ അയയ്‌ക്കരുത്.
  • കീ ഐഡി, അഭ്യർത്ഥന ഐഡി, ഓപ്പറേഷൻ ഐഡി എന്നിവ ലോഗ് ചെയ്യുക; പൂർണ്ണ കീ ഒരിക്കലും ലോഗ് ചെയ്യരുത്.
  • ഒരു കീ ചോർന്നാൽ, അത് ഒരേസമയം തിരിക്കുകയും അതിൻ്റെ ജോലികളും ചാർജുകളും അവലോകനം ചെയ്യുകയും ചെയ്യുക.