跳转到内容

Құжаттардың жұмыс процестерін қолданбаңызға енгізіңіз

Бір файлды жүктеуден бастап, оны аударуға, барысын тексеруге және нәтижені жүктеп алуға дейін. Әрбір қадам сіз интеграциялаған ретпен түсіндіріледі, сонымен қатар файлдарды басқару, құжаттарды өңдеу және аудио мен видео қызметтеріне арналған кіру нүктелері берілген.

Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · API кілті аутентификациясы · файлды аудару асинхронды тапсырмалар ретінде орындалады

Бұл сайт HTTP бұлтты API-ді сипаттайды.

01 Кредиттерді қажет етпейтін сұраныммен бастаңыз

Section titled “01 Кредиттерді қажет етпейтін сұраныммен бастаңыз”

Файлдарды жүктеуден бұрын кілтіңіз бен желінің жұмыс істейтініне көз жеткізіңіз. Баланс тексеруі ешқандай несие жұмсамайды және аударма тапсырмасын туғызбайды.

  1. API кілтін алыңыз

    API консоліне кіріңіз және sk_ басталатын кілт жасаңыз. Әрбір қосымша үшін жеке кілт пайдаланып, оған бюджет белгілеңіз.

    Кілт оны жасаған есептік жазба үшін жұмыс істейді. Оны серверде сақтаңыз және орташа айнымалыдан оқыңыз; оны ешқашан веб-бет дереккөзіне немесе жария репозиторийге енгізбеңіз.

  2. Балансты тексеру

    OMNIDOC_API_KEY ортақ айнымалысын орнатыңыз, содан кейін төмендегі мысалдардың кез келгенін іске қосыңыз. Сәттілік жағдайда JSON қайтарылады; 401 — кілтте мәселе бар дегенді білдіреді және оны тексеру қажет. Тикеттерде, скриншоттарда немесе журналдарда толық кілтті ешқашан көрсетпеңіз.

    Terminal window
    export OMNIDOC_API_KEY="sk_your_key"
    curl --fail-with-body --silent --show-error \
    'https://omnidoc.top/api/v1/billing/credits/balance' \
    -H "X-API-Key: $OMNIDOC_API_KEY"

Сәтті жүктеу тек файлдың сақталғанын білдіреді. Жұмыс жасағаннан кейін, оның соңғы күйге жетуін күтіп, содан кейін нәтижелерін тізімдеңіз және жүктеп алыңыз.

ҚадамӘдіс және жолНені сақтау керек
Жүктеуді сұрауPOST /upload/presignupload_url, upload_headers, finalize_token
Файлды жіберіңізPUT қайтарылған upload_url-геСәтті жауап; бұл сұрақта API кілті жоқ
Жүктеуді растаңызPOST /upload/finalizedocument.id
Аударма жасаңызPOST /jobsЖұмыс id
Мәртебені тексеруGET /jobs/{job_id}completed немесе failed
Нәтижелерді тізімдеңізGET /artifacts?job_id={job_id}Артефакт идентификаторлары мен форматтары
Нәтижені жүктеуGET /artifacts/{artifact_id}/downloadФайл байттары және жауап файлының атауы

Тікелей жүктеу үшін серверден upload_headers дәл осылай қайтарылған күйінде жіберіңіз, ал сақтау мекенжайына ешқашан X-API-Key жібермеңіз. Егер жүктеу мекенжайының мерзімі өтсе немесе тасымалдау сәтсіз аяқталса, жаңасын сұраңыз. Егжей-тегжей: жүктеу хаттамасы , жылдам бастау , толық Node.js жұмыс процесі және аударма сұранысы өрістері .

03 Тапсырмаңыздың соңғы нүктесін табыңыз

Section titled “03 Тапсырмаңыздың соңғы нүктесін табыңыз”

Әрбір жазба жолдарды, сұраным өрістерін және мысалдарды көрсетеді. Сіздің тіркелгіңіздің қызмет көрсету мәртебесі мен кілтіңіздің шектеулері олардың барлығына қолданылады.

04 Аутентификация және ресурстың меншік иесі

Section titled “04 Аутентификация және ресурстың меншік иесі”

API кілті аккаунтты сәйкестендіреді. Бұл файлды жүктеп алуға арналған жария пароль емес.

Сұраным тақырыбы

X-API-Key: sk_… немесе Authorization: Bearer sk_… қолданыңыз, сұраныс бойынша екеуінің біреуін. JSON денелерімен бірге Content-Type: application/json жіберіңіз.

Кілт қол жеткізе алатын нәрсе

Кілт тек оның есептік жазбасы пайдалана алатын ресурстарға ғана жетеді; қызмет мәртебесі, кілттің бюджеті және рұқсат етілген аудару параметрлері әлі де қолданылады. Есептік жазбаға өзгерістер енгізу, кілттерді жасау, айналдыру немесе жою консольде жүзеге асырылады.

Қараңыз аутентификация, бюджеттер және ротация және қызметтер мен рұқсаттар .

05 Интеграцияға құрастырудағы сәтсіздіктерді өңдеуді енгізу

Section titled “05 Интеграцияға құрастырудағы сәтсіздіктерді өңдеуді енгізу”

Уақытша үзіліс жұмыстың жасалмағанын білдірмейді. Ештеңе екі рет жіберілмеуі немесе өңделмеуі үшін, түзетуді қажет ететін сұранымдардан қайта тырысуға болатын қателіктерді ажыратыңыз.

  • Идемпотентті жасау : әрбір жаңа жасау операциясы үшін Idempotency-Key генерациялаңыз; сол операцияны қайта жасағанда, түпнұсқа кілт пен дәл сондай сұраным денесін қайта пайдаланыңыз. Кілтті құжат операциялары, медиа жұмыстары және дауысты жасау үшін қажет; басқа жасау эндпоинттары үшін олардың анықтамалық беттерін қараңыз.
  • Асинхронды хабарландырулар : алғашқы интеграция үшін опрос жақсы; үздіксіз бару үшін SSE пайдаланыңыз, ал фонда соңғы күйлерді алу үшін webhook -ны қолданыңыз.
МәртебеАлдымен тексеріңізНе істеу керек
401 / 403Кілт, рұқсаттар, ресурстар иелігіКредиттік деректерді немесе рұқсаттарды түзетіңіз; көрсетілген әрекеттерді қайталаудан аулақ болыңыз.
402Қол жетімді несиелерТолықтырыңыз, содан кейін қайтадан жіберіңіз
409Идемпотенттік кілті мен денесі, ресурстың күйіЖаңа операцияны бастамас бұрын алғашқы операцияны сұраңыз
422Жауаптағы өріс қателеріПараметрлерді немесе файлды түзетіңіз
429Бизнес code және Retry-AfterТариф пен кезектік шектеулерді күтуге болады; бір рет пайдаланылған кілт бюджетін алдымен ұлғайту керек
5xxУақытша қызмет қатесіШектеулі экспоненциалды кері санау; жасау сұраныстары үшін идемпотенттік кілтті сақтаңыз

Ақаулықтарды шешу үшін X-Request-Id жауап тағанын, сұраным уақытын және жолды сақтаңыз; толық кілтті ешқашан жазбаңыз. Барлық қате кодтары мен қайта тырысу мысалдары қате анықтамасы бөлімінде келтірілген.

06 Интеграциялау алдында есеп айырысу жүйесінің қалай жұмыс істейтінін тексеріңіз

Section titled “06 Интеграциялау алдында есеп айырысу жүйесінің қалай жұмыс істейтінін тексеріңіз”

Кредиттер жоқ

Жүктеу, тапсырмаларды тексеру, нәтижелерді жүктеу және баланс пен есеп айырысу жазбаларын оқу несие жұмсамайды; сондай-ақ глоссарийлер, жобалар, тегтер, іздеу және бөлісу де несие жұмсамайды.

Пайдалану бойынша есептеледі

Файлды аудару, құжаттарға арналған құралдар, жедел аударма және аудио мен бейне сервистерінің бағасы нақты пайдалану көлеміне сәйкес белгіленеді; тапсырманы жасау тек соңғы шығын емес.

Жұмыс басталғанға дейін тек теңгерім шегі тексеріледі; ал ол аяқталғаннан кейін нақты пайдалану үшін төлем жасалады. Егер теңгерім жеткіліксіз болса, айырмашылық қарыз ретінде есепке алынады, ал кейінірек келген несиелер оны бірінші кезекте өтейді. Сіз төлемдер мен қайтарымдарды жұмыс немесе несие операциясы бойынша теңестіре аласыз. Кілттің бюджеті таусылған жағдайда да сіз сол кілт бойынша жұмыстарды, нәтижелерді және жазбаларды сұрай аласыз.