Tovább a tartalomhoz

Hozza be az alkalmazásába a dokumentum-munkafolyamatokat

Az egyes fájlok feltöltésétől a fordításukon, a folyamat ellenőrzésén át az eredmény letöltéséig minden lépést részletesen bemutatunk. Minden szakasz sorrendben kerül ismertetésre, a fájlkezelési, dokumentumfeldolgozási valamint audio- és videószolgáltatásokhoz vezető belépési pontokkal.

Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · API-kulcsos hitelesítés · a fájlfordítás szinkronizálatlan feladatként fut

Ez az oldal a HTTP felhő API-ját ismerteti.

01 Kezdjen egy olyan kéréssel, amely nem kerül hitelpontba

Szekció neve “01 Kezdjen egy olyan kéréssel, amely nem kerül hitelpontba”

Győződjön meg róla, hogy a kulcsa és a hálózata működik, mielőtt fájlokat tölt fel. Az egyensúly-ellenőrzés nem kerül kreditbe és nem hoz létre fordítási feladatot.

  1. Szerezzen API kulcsot

    Jelentkezzen be az API-konzolba és hozzon létre egy kulcsot, amely sk_-vel kezdődik. Használjon külön kulcsot minden alkalmazáshoz, és állítsa be a költségkeretét.

    A kulcs az azt létrehozó fiók számára érvényes. Tartsa a kiszolgálón, és olvassa be egy környezeti változóból; soha ne helyezze el a weboldal forrásában vagy nyilvános tárolóban.

  2. Ellenőrizze az egyenleget

    Állítsa be a OMNIDOC_API_KEY környezeti változót, majd futtassa le az alábbi példák bármelyikét. A sikeres visszatérési érték JSON; 401 azt jelenti, hogy a kulcs problémás, és ellenőrizni kell. Soha ne jelenítse meg a teljes kulcsot jegyekben, képernyőképeken vagy naplófájlokban.

    Terminál
    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"

A sikeres feltöltés csupán annyit jelent, hogy a fájl tárolásra került. Miután létrehozott egy feladatot, várja meg, amíg az elér egy végleges állapotot, majd listázza és töltse le az eredményeit.

LépésMódszer és útvonalMit kell megtartani
Kérjen feltöltéstPOST /upload/presignupload_url, upload_headers, finalize_token
Küldje el a fájltPUT a visszatérített upload_urlSikeres válasz; ez a kérés nem tartalmaz API kulcsot.
Erősítse meg a feltöltéstPOST /upload/finalizedocument.id
Hozzon létre egy fordulatotPOST /jobsMunka id
Ellenőrizze az állapototGET /jobs/{job_id}completed vagy failed
Listázza az eredményeketGET /artifacts?job_id={job_id}Műtermék-azonosítók és formátumok
Ergebnis letöltéseGET /artifacts/{artifact_id}/downloadFájlbytek és a válaszfájl neve

A közvetlen feltöltéshez küldje el a upload_headers az eredeti formában, pontosan úgy, ahogy a szerver visszaadta, és soha ne küldjön X-API-Key-et a tárolócímre. Ha a feltöltési cím lejár, vagy az átvitel sikertelen, kérjen újat. Részletek: feltöltési protokoll, gyorsindítás, teljes Node.js munkafolyamat és fordítási kérelem mezői.

Minden bejegyzés felsorolja az útvonalakat, kéréstáblázatokat és példákat. Az Ön fiókjának szolgáltatás-állapota és kulcsának korlátai mindre vonatkoznak.

04 Hitelesítés és erőforrás-tulajdonos

Szekció neve “04 Hitelesítés és erőforrás-tulajdonos”

Egy API-kulcs egy fiókot azonosít. Ez nem egy fájl nyilvános letöltési jelszava.

Kérésfejléc

Használja a X-API-Key: sk_… vagy a Authorization: Bearer sk_… szolgáltatást, kérésenként az egyiket. Küldje a Content-Type: application/json szolgáltatást a JSON testekkel együtt.

Mit érhet el egy kulcs

Egy kulcs csak azokhoz a erőforrásokhoz fér hozzá, amelyeket a fiókja használhat; a szolgáltatás állapota, a kulcs költségkerete és az engedélyezett fordítási beállítások továbbra is érvényesek. A fiókkal kapcsolatos módosítások, valamint a kulcsok létrehozása, cseréje vagy visszavonása a konzolban történik.

Lásd hitelesítés, költségvetések és rotáció és szolgáltatások és jogosultságok .

05 Építési hibakezelés az integrációba beépítve

Szekció neve “05 Építési hibakezelés az integrációba beépítve”

A határidő lejárta nem jelenti azt, hogy a feladat nem lett létrehozva. Különbséget kell tenni a megismételhető hibák és a javítást igénylő kérések között, hogy semmi ne kerüljön beadványba vagy feldolgozásra kétszer.

  • Idempotens létrehozás : minden új létrehozási művelethez generáljon egy Idempotency-Key -t; ha ugyanazt a műveletet újra próbálja meg, használja fel az eredeti kulcsot és pontosan ugyanazt a kérelemtestet. A dokumentumok műveleteihez, médiafeladatokhoz és hanglétrehozáshoz szükséges a kulcs; a többi létrehozási végpont esetén lásd a vonatkozó referenciaoldalakat.
  • Aszinkron értesítések : az első integrációhoz a lekérdezés megfelelő; folyamatos haladás esetén használja a SSE , és a háttérben történő végső állapotok fogadásához pedig egy webhookot -t.
ÁllapotElőször ellenőrizzeMit kell tenni
401 / 403Kulcs, engedélyek, erőforrás-tulajdonosJavítsa a hitelesítési adatokat vagy jogosultságokat; ne próbálkozzon újra vakon.
402Elérhető kreditekTöltse fel az egyenleget, majd küldje be újra
409Az idempotencia kulcsa és testrésze, az erőforrás állapotaIndítsa el az új műveletet, mielőtt lekérdezné az eredeti műveletet.
422A válaszban szereplő mezőhibákJavítsa ki a paramétereket vagy a fájlt
429Üzleti code és Retry-AfterAz árfolyam- és sorrendkorlátok lejárhatnak; a felhasznált kulcskeretet előbb meg kell emelni.
5xxIdeiglenes szolgáltatási hibaKorlátozott exponenciális visszavárás; a létrehozási kérések esetén tartsa meg az idempotencia kulcsot

Tartsa meg a X-Request-Id válaszfejlécet, a kérések idejét és az útvonalat hibaelhárításhoz; soha ne naplózza a teljes kulcsot. Minden hibakód és újrapróbálási példa az hiba referencia ban található.

06 Ellenőrizze a számlázás működését az integráció előtt

Szekció neve “06 Ellenőrizze a számlázás működését az integráció előtt”

Nincs kredit

A feltöltés, a feladatok ellenőrzése, az eredmények letöltése, valamint az egyenleg- és elszámolási rekordok olvasása nem kerül költségpontba; ugyanígy a glosszáriumok, projektek, címkék, keresés és megosztás sem.

Felhasználás szerinti számlázás

A fájlfordítás, a dokumentumeszközök, az azonnali fordítás és a hang- és videószolgáltatások díját a tényleges felhasználás alapján számolják fel; a munka létrehozása nem jelenti a végső díjat.

A munka megkezdése előtt csak az egyenleg küszöbértéke kerül ellenőrzésre; a munka befejezése után a tényleges felhasználás kerül elszámolásra. Ha az egyenleg nem elegendő, a különbözet adósságként kerül nyilvántartásra, és a később érkező jóváírások ezt elsőként fedezik. Az elszámolásokat és visszatérítéseket munkánként vagy jóváírás-műveletenként egyeztetheti. Amennyiben egy kulcs költségvetése kiürült, továbbra is lekérdezheti az adott kulcs alatti munkákat, eredményeket és rekordokat.