Preskočiť na obsah

Zapojte dokumentové pracovné postupy do vašej aplikácie

Od nahratia jedného súboru cez jeho preklad, kontrolu priebehu až po stiahnutie výsledku. Každý krok je vysvetlený v poradí, v akom ich integrujete, s bodmi prístupu pre správu súborov, spracovanie dokumentov a audio a video služby.

Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Autentifikácia pomocou kľúča API · prevod súborov prebieha ako asynchrónne úlohy

Táto stránka popisuje cloudové rozhranie HTTP.

01 Začnite žiadosťou, ktorá nestojí žiadne kredity

Section titled “01 Začnite žiadosťou, ktorá nestojí žiadne kredity”

Pred nahrávaním súborov sa uistite, že váš kľúč a sieť fungujú. Kontrola zostatku nestojí žiadne kredity a nevytvára žiadnu prekladovú úlohu.

  1. Získajte kľúč API

    Prihláste sa do API konzoly a vytvorte kľúč začínajúci na sk_. Používajte samostatný kľúč pre každú aplikáciu a priraďte mu rozpočet.

    Kľúč slúži pre účet, ktorý ho vytvoril. Uchovávajte ho na serveri a čítajte ho z premenného prostredia; nikdy ho neuvádzajte do zdrojového kódu webovej stránky ani do verejného repozitára.

  2. Skontrolujte zostatok

    Nastavte premennú prostredia OMNIDOC_API_KEY a potom spustite niektorý z nasledujúcich príkladov. Úspech vráti JSON; 401 znamená, že kľúč má problém a je potrebné ho skontrolovať. Nikdy nezobrazujte celý kľúč v tiketoch, snímkach obrazovky ani protokoloch.

    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"

Úspešné nahratie znamená iba, že súbor bol uložený. Po vytvorení úlohy počkajte, kým nedosiahne konečný stav, a potom si zoberte zoznam jej výsledkov a stiahnite ich.

KrokMetóda a cestaČo zachovať
Požiadajte o nahratiePOST /upload/presignupload_url, upload_headers, finalize_token
Odošlite súborPUT na vrátené upload_urlOdpoveď o úspešnom vykonaní; táto požiadavka neobsahuje žiadny API kľúč.
Potvrďte nahrávaniePOST /upload/finalizedocument.id
Vytvorte prekladPOST /jobsZamestnanie id
Skontrolujte stavGET /jobs/{job_id}completed alebo failed
Vypíšte výsledkyGET /artifacts?job_id={job_id}ID artefaktov a formáty
Stiahnuť výsledokGET /artifacts/{artifact_id}/downloadSúbory bajtov a názov súboru odpovede

For the direct upload, send the upload_headers from the server exactly as returned, and never send X-API-Key to the storage address. If the upload address expires or the transfer fails, request a new one. Details: upload protocol, quick start, complete Node.js workflow and translation request fields.

Každý záznam uvádza cesty, požiadavkové polia a príklady. Stav služby vášho účtu a limity vášho kľúča sa vzťahujú na všetky z nich.

Kľúč API identifikuje účet. Nie je to verejný heslo na stiahnutie súboru.

Záhlavie požiadavky

Použite X-API-Key: sk_… alebo Authorization: Bearer sk_…, jeden z nich na každú žiadosť. Pošlite Content-Type: application/json s telami JSON.

Čo dokáže kľúč dosiahnuť

Kľúč má prístup iba k prostriedkom, ktoré môže používať jeho účet; platia stále nastavenia služby, rozpočet kľúča a povolené nastavenia prekladu. Zmeny v účte a vytváranie, rotovanie alebo zrušenie kľúčov sa vykonávajú v konzole.

Pozri autentifikácia, rozpočty a rotácia a služby a oprávnenia .

05 Zahrnutie spracovania chýb pri zostavovaní do integrácie

Section titled “05 Zahrnutie spracovania chýb pri zostavovaní do integrácie”

Časový limit neznamená, že úloha nebola vytvorená. Rozlišujte medzi chybami, ktoré je možné opakovať, a požiadavkami, ktoré je potrebné opraviť, aby sa nič neodoslalo alebo nespracovalo dvakrát.

  • Idempotentná tvorba : pre každú novú operáciu vytvorenia vygenerujte Idempotency-Key; pri opakovaní rovnakej operácie použite pôvodný kľúč a presne rovnaké telo požiadavky. Operácie dokumentov, médií a tvorby hlasu vyžadujú tento kľúč; pre ostatné koncové body vytvárania pozrite ich referenčné stránky.
  • Asynchrónne oznámenia : polling je vhodný pre prvú integráciu; na sledovanie priebehu použite SSE , a na prijímanie konečných stavov v pozadí použite webhook . .
StavNajskôr skontrolujteČo robiť
401 / 403Kľúč, povolenia, vlastníctvo zdrojovOpravte poverenia alebo práva; neopakujte pokus bezhlavo.
402Dostupné kredityDoplňte zostatok a potom odošlite znova.
409Kľúč a telo idempotencie, stav zdrojaPred spustením novej operácie si overte pôvodnú operáciu.
422Chyby v poliach v odpovediOpravte parametre alebo súbor
429Obchodné code a Retry-AfterLimitov na rýchlosť a fronty je možné počkať; predtým je potrebné zvýšiť vyčerpaný rozpočet kľúčov.
5xxDočasná chyba službyObmedzený exponenciálny opakovaný pokus; zachovajte kľúč idempotencie pre požiadavky na vytvorenie

Uchovajte hlavičku odpovede X-Request-Id, čas požiadavky a cestu na riešenie problémov; nikdy nezapisujte celý kľúč. Všetky kódy chýb a príklady opakovaných pokusov sú v referencii chýb . .

06 Skontrolujte, ako funguje fakturácia, predtým ako ju integrujete

Section titled “06 Skontrolujte, ako funguje fakturácia, predtým ako ju integrujete”

Žiadne kredity

Nahrávanie, kontrola úloh, sťahovanie výsledkov a čítanie zostatku a záznamov o vypočítaní nezapočítavajú žiadne kredity; rovnako tak ani glosáre, projekty, značky, vyhľadávanie a zdieľanie.

Účtované podľa použitia

Preklad súborov, nástroje na dokumenty, okamžitý preklad a služby pre audio a video sa účtujú podľa skutočného využitia; vytvorenie úlohy nie je konečná cena.

Pred spustením úlohy sa kontroluje iba prah zostatku; po jej dokončení sa účtuje skutočné využitie. Ak zostatok nestačí, rozdiel sa eviduje ako dlh a neskôr pripísané kredity ho najprv splácajú. Môžete vyrovnať poplatky a vrátenia peňazí podľa jednotlivých úloh alebo operácií s kreditmi. Keď je rozpočet kľúča vyčerpaný, stále môžete dotazovať úlohy, výsledky a záznamy pre daný kľúč.