跳转到内容

ప్రామాణీకరణ మరియు 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 ద్వారా తిరిగి ఇచ్చిన అప్‌లోడ్ లేదా డౌన్‌లోడ్ చిరునామాలకు కీని ఎప్పుడూ పంపవద్దు.
  • కీ ఐడీ, రిక్వెస్ట్ ఐడీ మరియు ఆపరేషన్ ఐడీని లాగ్ చేయండి; పూర్తి కీని ఎప్పుడూ లాగ్ చేయవద్దు.
  • కీ లీక్ అయితే, వెంటనే దాన్ని రొటేట్ చేసి, దాని జాబ్‌లు మరియు ఛార్జెస్‌ను సమీక్షించండి.