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.
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.
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.
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.
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.
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());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.
| Korak | Metod i put | Šta da se sačuva |
|---|---|---|
| Zatražite otpremu | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Pošaljite datoteku | PUT do vraćenog upload_url | Odgovor o uspešnom izvršenju; ovaj zahtev ne sadrži API ključ |
| Potvrdite preuzimanje | POST /upload/finalize | document.id |
| Napravite prevod | POST /jobs | Posao id |
| Proverite status | GET /jobs/{job_id} | completed ili failed |
| Navedite rezultate | GET /artifacts?job_id={job_id} | ID artefakata i formati |
| Preuzmite rezultat | GET /artifacts/{artifact_id}/download | Bajtovi 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.
Svaki unos navodi puteve, polja zahteva i primere. Status usluge vašeg naloga i limiti vašeg ključa odnose se na sve njih.
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 .
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.
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.| Status | Prvo proverite | Šta uraditi |
|---|---|---|
401 / 403 | Ključ, dozvole, vlasništvo nad resursima | Ispravite akreditive ili dozvole; nemojte ponovo pokušavati bez razmišljanja |
402 | Dostupni krediti | Napunite saldo, a potom ponovo pošaljite |
409 | Ključ i telo idempotentnosti, stanje resursa | Proverite originalnu operaciju pre nego što započnete novu |
422 | Greške polja u odgovoru | Ispravite parametre ili datoteku |
429 | Poslovne code i Retry-After | Limiti stope i reda čekanja se mogu isčekati; prvo mora da se poveća potrošen budžet ključeva. |
5xx | Privremena greška servisa | Ogranič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 .
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č.