跳转到内容

Unesite radne točke s dokumentima u svoju aplikaciju

Od učitavanja jedne datoteke do njezinog prijevoda, provjere napretka i preuzimanja rezultata. Svaki korak objašnjen je redoslijedom vaše integracije, s točkama pristupa za upravljanje datotekama, obradu dokumenata te audio i video usluge.

Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Autentifikacija pomoću ključa API-a · izvođenje prevoda datoteka kao asinhronih zadataka

Ova stranica opisuje API oblaka HTTP.

01 Započnite s zahtjevom koji ne košta kredite

Section titled “01 Započnite s zahtjevom koji ne košta kredite”

Provjerite da vaš ključ i mreža funkcioniraju prije nego što prenesete datoteke. Provjera stanja na računu ne oduzima kredite niti stvara zadatak za prijevod.

  1. Za dobivanje ključa API-a

    Prijavite se na API konzolu i kreirajte ključ koji počinje s sk_. Koristite zaseban ključ za svaku aplikaciju i odredite mu budžet.

    Ključ vrijedi za račun koji ga je kreirao. Čuvajte ga na serveru i čitajte ga iz promjenljive okoline; nikada ga ne stavljajte u izvor web stranice ili javni repozitorij.

  2. Provjerite stanje

    Postavite okružnu promjenljivu OMNIDOC_API_KEY, a zatim pokrenite bilo koji od dolje navedenih primjera. Uspjeh vraća JSON; 401 znači da ključ ima problem i treba ga provjeriti. Nikada ne prikazujte cijeli ključ u tiketima, snimkama zaslona ili logovima.

    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"

Uspješno učitavanje samo znači da je datoteka pohranjena. Nakon što kreirate zadatka, pričekajte da dostigne konačno stanje, a zatim navedite i preuzmite njegove rezultate.

KorakMetoda i putanjaŠto zadržati
Zatražite učitavanjePOST /upload/presignupload_url, upload_headers, finalize_token
Pošalji datotekuPUT do vraćenog upload_urlOdgovor o uspješnom izvršenju; ovaj zahtjev ne sadrži API ključ.
Potvrdite učitavanjePOST /upload/finalizedocument.id
Stvorite prijevodPOST /jobsPosao id
Provjerite statusGET /jobs/{job_id}completed ili failed
Popis rezultataGET /artifacts?job_id={job_id}ID-ovi i formati artefakata
Preuzmite rezultatGET /artifacts/{artifact_id}/downloadBajtovi datoteke i naziv datoteke odgovora

Za izravno učitavanje pošaljite upload_headers s poslužitelja točno onako kako je vraćeno i nikada ne šaljite X-API-Key na adresu za pohranu. Ako adresa za učitavanje istekne ili prijenos ne uspije, zatražite novu. Detalji: protokol za učitavanje, brzi početak, cijeli tijek rada Node.js i polja za zahtjev za prijevod.

03 Pronađite krajnju točku za svoj zadatak

Section titled “03 Pronađite krajnju točku za svoj zadatak”

Svaki unos navodi putanje, polja zahtjeva i primjere. Status usluge vašeg računa i ograničenja vašeg ključa primjenjuju se na sve njih.

04 Autentifikacija i vlasništvo nad resursima

Section titled “04 Autentifikacija i vlasništvo nad resursima”

API ključ identificira račun. To nije javna lozinka za preuzimanje datoteke.

Zaglavlje zahtjeva

Koristite X-API-Key: sk_… ili Authorization: Bearer sk_…, jedan od njih dvoje po zahtjevu. Pošaljite Content-Type: application/json s tijelima JSON.

Što ključ može dosegnuti

Ključ pristupa samo resursima koje njegov račun može koristiti; status usluge, budžet ključa i dopuštena postavka prevoda i dalje vrijede. Promjene računa te kreiranje, rotacija ili otkazivanje ključeva obavljaju se u konzoli.

Vidjeti autentifikaciju, proračune i rotaciju i servise i dozvole .

05 Ugradnja obrade neuspjeha pri izradi u integraciju

Section titled “05 Ugradnja obrade neuspjeha pri izradi u integraciju”

Vrijeme izvršavanja ne znači da zadatak nije kreiran. Razlikujte pogreške koje se mogu ponoviti od zahtjeva koji trebaju popravak, kako ništa ne bi bilo predano ili obrađeno dva puta.

  • Idempotentna kreiranje : generirajte Idempotency-Key za svaku novu operaciju kreiranja; kada ponovno pokušate istu operaciju, ponovno koristite izvorni ključ i potpuno isto tijelo zahtjeva. Operacije dokumenta, zadaci za medije i kreiranje glasa zahtijevaju ključ; za ostale krajnje točke kreiranja pogledajte njihove referentne stranice.
  • Asinhrone obavijesti : polling je u redu za prvu integraciju; za kontinuirani napredak koristite SSE , a za primanje konačnih stanja u pozadini koristite webhook .
StatusPrvo provjeriteŠto učiniti
401 / 403Ključ, dozvole, vlasništvo nad resursimaPopravite vjerodajnice ili dozvole; nemojte ponovno pokušavati bez razmišljanja
402Dostupni kreditiNapunite račun, a zatim ponovno pošaljite
409Ključ i tijelo idempotencije, stanje resursaPozovite izvornu operaciju prije pokretanja nove
422Pogreške polja u odgovoruPopravite parametre ili datoteku
429Poslovanje code i Retry-AfterOgraničenja brzine i reda čekanja mogu se isčekati; potrebno je prvo povećati potrošeni budžet ključeva.
5xxPrivremena greška uslugeOgraničeno eksponencijalno odgađanje; zadržite ključ idempotencije za zahtjeve za kreiranje

Zadržite zaglavlje odgovora X-Request-Id, vrijeme zahtjeva i putanjicu za rješavanje problema; nikada ne bilježite cijelu ključnu oznaku. Svi kodovi grešaka i primjeri ponovnog pokušaja nalaze se u referenci greška .

06 Provjerite kako funkcionira fakturiranje prije nego što ga integrirate

Section titled “06 Provjerite kako funkcionira fakturiranje prije nego što ga integrirate”

Bez kredita

Prijavlivanje, provjera zadataka, preuzimanje rezultata te čitanje stanja i evidencije o poravnanju ne troše kredite; isto vrijedi i za rječnike, projekte, oznake, pretraživanje i dijeljenje.

Fakturiran prema korištenju

Prijenos datoteka, alati za dokumente, trenutni prijevod te usluge audio i video sadržaja obračunavaju se prema stvarnoj potrošnji; kreiranje zadatka nije konačna naplata.

Prije početka zadatka provjerava se samo prag stanja; nakon njegova završetka obračunava se stvarna potrošnja. Ako stanje nije dovoljno, razlika se evidentira kao dug, a krediti koji kasnije pristignu prvo ga podmire. Možete izvršiti usklađivanje naplata i povrata za pojedini zadatak ili za pojedinu kreditnu operaciju. Kada se potroši budžet ključa, i dalje možete pretraživati zadatke, rezultate i zapise povezane s tim ključem.