Тіркелу және API кілттері
Кілт жасаңыз
Section titled “Кілт жасаңыз”Create an sk_ API key in the API center. The full key is shown only once, when it is created or rotated.
Әрбір қолданба, орта және автоматтандырылған тапсырма үшін жеке кілт пайдаланыңыз, сонда олардың әрқайсысының өз бюджеті болады және оларды өз бетімен өшіруге, ауыстыруға және тексеруге болады.
Креденциалды жіберіңіз
Section titled “Креденциалды жіберіңіз”Ұсынылған:
X-API-Key: sk_your_keyСтандартты Bearer нысаны да жұмыс істейді:
Authorization: Bearer sk_your_keyСұранымда екеуінің біреуін ғана жіберіңіз.
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 орталығында . Кілт жойылғаннан, өшірілгеннен немесе мерзімі өткеннен немесе оның аккаунты өшірілгеннен кейін жаңа сұранымдар бірден сәтсіздікке ұшырайды.
Айналдыру жаңа құпия сөзді жасайды және ескісін бірден өшіреді; жаңа кілт бастапқы шектеулер мен қолданылған бюджетті сақтайды. Мерзімі өткен кілтті айналдыру мүмкін емес; оның орнына жаңасын жасаңыз. Ауысу процесінің кедергісіз болуы үшін, жаңа кілт жасап, оны іске қосыңыз, шақырулар сәтті орындалатынына көз жеткізіңіз, содан кейін ескі кілтті жойыңыз.
Қауіпсіздік
Section titled “Қауіпсіздік”- Кілттерді тек серверде немесе бақыланатын орындау ортасында сақтаңыз.
- Орташа айнымалыларды немесе құпия деректер менеджерін пайдаланыңыз; кілттерді ешқашан бастапқы кодқа, журналдарға, шолғыш жинақтарына немесе жалпыға қолжетімді репозиторийлерге орналастырмаңыз.
- API қайтарған жүктеу немесе жүктеу мекенжайларына ешқашан кілт жібермеңіз.
- Кілт ID-сін, сұраным ID-сін және операция ID-сін жазыңыз; толық кілтті ешқашан жазбаңыз.
- Егер кілт құпиясы жарияланған жағдайда, оны дереу ауыстырыңыз және оның пайдаланылуы мен жүктемесін тексеріңіз.