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.
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.
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.
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.
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.
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"import osimport requests
response = requests.get( "https://omnidoc.top/api/v1/billing/credits/balance", headers={"X-API-Key": os.environ["OMNIDOC_API_KEY"]}, timeout=30,)response.raise_for_status()print(response.json())// Node.js 20+, save as balance.mjsconst apiKey = process.env.OMNIDOC_API_KEY;if (!apiKey) throw new Error('Set OMNIDOC_API_KEY');const response = await fetch('https://omnidoc.top/api/v1/billing/credits/balance', { headers: { 'X-API-Key': apiKey }, signal: AbortSignal.timeout(30_000),});if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);console.log(await response.json());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és | Módszer és útvonal | Mit kell megtartani |
|---|---|---|
| Kérjen feltöltést | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Küldje el a fájlt | PUT a visszatérített upload_url | Sikeres válasz; ez a kérés nem tartalmaz API kulcsot. |
| Erősítse meg a feltöltést | POST /upload/finalize | document.id |
| Hozzon létre egy fordulatot | POST /jobs | Munka id |
| Ellenőrizze az állapotot | GET /jobs/{job_id} | completed vagy failed |
| Listázza az eredményeket | GET /artifacts?job_id={job_id} | Műtermék-azonosítók és formátumok |
| Ergebnis letöltése | GET /artifacts/{artifact_id}/download | Fá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.
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 .
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.
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.| Állapot | Először ellenőrizze | Mit kell tenni |
|---|---|---|
401 / 403 | Kulcs, engedélyek, erőforrás-tulajdonos | Javítsa a hitelesítési adatokat vagy jogosultságokat; ne próbálkozzon újra vakon. |
402 | Elérhető kreditek | Töltse fel az egyenleget, majd küldje be újra |
409 | Az idempotencia kulcsa és testrésze, az erőforrás állapota | Indítsa el az új műveletet, mielőtt lekérdezné az eredeti műveletet. |
422 | A válaszban szereplő mezőhibák | Javítsa ki a paramétereket vagy a fájlt |
429 | Üzleti code és Retry-After | Az árfolyam- és sorrendkorlátok lejárhatnak; a felhasznált kulcskeretet előbb meg kell emelni. |
5xx | Ideiglenes szolgáltatási hiba | Korlá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ó.
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.