跳转到内容

Unesite radnje sa dokumentima u svoju aplikaciju

Od otpremanja jedne datoteke do njenog prevoda, provere statusa obrade i preuzimanja rezultata. Svaki korak je objašnjen u redosledu kojim ga integrišete, sa tačkama za upravljanje datotekama, obradu dokumenta i usluge audio i video zapisa.

Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Autentifikacija pomoću ključa API-ja · translacija datoteka se izvodi kao asinhroni zadaci

Ovaj sajt opisuje API oblaka HTTP.

01 Započnite zahtevom koji ne košta kredite

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

Proverite da li vaš privatni ključ i mreža funkcionišu pre nego što otpremite datoteke. Provera bilansa ne košta kredite i ne kreira zadatak za prevod.

  1. Dobijte API ključ

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

    Ključ važi za nalog koji ga je kreirao. Čuvajte ga na serveru i čitajte ga iz promenljive okruženja; nikada ga ne stavljajte u izvornu kod veb stranice ili u javni repozitorijum.

  2. Proveri bilans

    Postavite promenljivu okruženja OMNIDOC_API_KEY, a zatim pokrenite bilo koji od donjih primera. Uspeh vraća JSON; 401 znači da ključ ima problem i potrebno je proveriti ga. Nikada ne prikazujte punu vrednost ključa u tiketima, snimcima ekrana 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"

Uspešno otpremanje samo znači da je datoteka sačuvana. Nakon što kreirate zadatak, sačekajte da dostigne konačno stanje, a zatim navedite i preuzmite njegove rezultate.

KorakMetod i putŠta da se sačuva
Zatražite otpremuPOST /upload/presignupload_url, upload_headers, finalize_token
Pošaljite datotekuPUT do vraćenog upload_urlOdgovor o uspešnom izvršenju; ovaj zahtev ne sadrži API ključ
Potvrdite preuzimanjePOST /upload/finalizedocument.id
Napravite prevodPOST /jobsPosao id
Proverite statusGET /jobs/{job_id}completed ili failed
Navedite rezultateGET /artifacts?job_id={job_id}ID artefakata i formati
Preuzmite rezultatGET /artifacts/{artifact_id}/downloadBajtovi datoteke i ime odgovorne datoteke

Za direktno otpremanje, pošaljite upload_headers sa servera tačno onako kako je vraćen i nikada ne šaljite X-API-Key na adresu za skladištenje. Ako adresa za otpremanje istekne ili prenos ne uspe, zatražite novu. Detalji: protokol otpremanja, brzi start, kompletan Node.js radni proces i polja za zahtev za prevod.

03 Pronađite krajnju tačku za vaš zadatak

Section titled “03 Pronađite krajnju tačku za vaš zadatak”

Svaki unos navodi puteve, polja zahteva i primere. Status usluge vašeg naloga i limiti vašeg ključa odnose se na sve njih.

04 Autentikacija i vlasništvo nad resursima

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

Ključ API-ja identifikuje nalog. To nije javna lozinka za preuzimanje datoteke.

Zaglavlje zahteva

Koristite X-API-Key: sk_… ili Authorization: Bearer sk_…, po jedan od dva za svaki zahtev. Pošaljite Content-Type: application/json sa telom JSON.

Šta ključ može da dostigne

Ključ ima pristup samo resursima koje njegov nalog može da koristi; status usluge, budžet ključa i dozvoljena podešavanja prevoda i dalje važe. Promene naloga i kreiranje, rotacija ili opoziv ključeva vrše se u konzoli.

Videti autentikaciju, budžete i rotaciju i usluge i dozvole .

05 Uključivanje obrade neuspešnih izgradnji u integraciju

Section titled “05 Uključivanje obrade neuspešnih izgradnji u integraciju”

Vremenski iznos ne znači da zadatak nije kreiran. Razlikujte greške koje se mogu ponoviti od zahteva koje je potrebno popraviti, kako ništa ne bi bilo poslato ili obrađeno dva puta.

  • Idempotentna kreacija : generišite Idempotency-Key za svaku novu operaciju kreiranja; kada ponovo pokrenete istu operaciju, koristite originalni ključ i potpuno isto telo zahteva. Operacije dokumenta, medijski zadaci i kreacija glasa zahtevaju ključ; za ostale enpointove za kreiranje pogledajte njihove referentne stranice.
  • Asinhrone notifikacije : opoziv je u redu za prvu integraciju; za kontinuirani napredak koristite SSE , a da biste primali konačna stanja u pozadini koristite vebhuk .
StatusPrvo proveriteŠta uraditi
401 / 403Ključ, dozvole, vlasništvo nad resursimaIspravite akreditive ili dozvole; nemojte ponovo pokušavati bez razmišljanja
402Dostupni kreditiNapunite saldo, a potom ponovo pošaljite
409Ključ i telo idempotentnosti, stanje resursaProverite originalnu operaciju pre nego što započnete novu
422Greške polja u odgovoruIspravite parametre ili datoteku
429Poslovne code i Retry-AfterLimiti stope i reda čekanja se mogu isčekati; prvo mora da se poveća potrošen budžet ključeva.
5xxPrivremena greška servisaOgraničeno eksponencijalno odlaganje; zadržite idempotentni ključ za zahteve za kreiranje

Sačuvajte zaglavlje odgovora X-Request-Id, vreme zahteva i putanju radi rešavanja problema; nikada ne beležite punu ključnu reč. Svi kodovi grešaka i primeri ponovnog pokušaja nalaze se u referenci na greške .

06 Proverite kako funkcioniše fakturisanje pre nego što integrišete

Section titled “06 Proverite kako funkcioniše fakturisanje pre nego što integrišete”

Bez kredita

Preuzimanje, provera zadataka, preuzimanje rezultata i čitanje bilansa i zapisa o poravnanju ne koštaju kredite; isto tako ne koštaju ni glasari, projekti, oznake, pretraga i deljenje.

Naplaćuje se prema upotrebi

Prevod datoteka, alatke za dokumente, trenutni prevod i usluge audio i video su plaćeni po stvarnoj upotrebi; kreiranje zadatka nije konačna naplata.

Pre početka zadatka proverava se samo prag bilansa; nakon završetka naplaćuje se stvarna potrošnja. Ako je bilans nedovoljan, razlika se evidentira kao dug, a krediti koji stignu kasnije prvo ga otplaćuju. Možete uskladiti troškove i povraćaje po zadatku ili po operaciji kredita. Kada se budžet za ključ iscrpi, i dalje možete da preuzimate podatke o zadacima, rezultatima i zapisima za taj ključ.