Pregled platforme
OmniDoc API podržava radne tokove fajlova i sadržaja unutar jednog naloga. Pozivajući korisnik kreira resurse pomoću ključa API-a, a zatim koristi stabilne ID-jeve koje dobije kako bi ih pretraživao, kombinovao, obrađivao ili preuzimao.
Model resursa
Section titled “Model resursa”| Resurs | Namena |
|---|---|
| Dokument / Datoteka | Izvorne datoteke i unosi u biblioteku datoteka koji su u vlasništvu naloga |
| Posao / Operacija | Asinhronsko prevođenje, obrada dokumenata ili audio i video zadaci |
| Artefakt | Rezultati koje posao obezbeđuje za pregled ili preuzimanje |
| Kreditna operacija | Zapis o tome šta je naplaćeno i vraćeno za jednu obračunsku akciju |
Svaki resurs se proverava u odnosu na nalog koji ga poseduje. Klijentima je potrebno da čuvaju samo javne ID-ove i ne treba da izvode zaključke o detaljima implementacije na osnovu ID-ova, imena datoteka ili adresa za preuzimanje.
Uobičajeni tok poziva
Section titled “Uobičajeni tok poziva”- Kreirajte ili odaberite ulazni resurs.
- Obavezno proverite da nalog ima sredstva: stanje se upoređuje sa pragom pre početka zadatka, a stvarna potrošnja se naplaćuje kada se zadatak završi.
- Kreirajte zadatak sa
Idempotency-Key. - Proverite status zadatka; zadaci za prevod datoteka takođe mogu da koriste SSE ili vebhuke.
- Pročitajte rezultate i kreditni zapis za ovaj zadatak.
Identitet
Section titled “Identitet”Spoljašnje integracije uvek koriste ključeve API-a, sa istim dozvolama kao i nalog koji je kreirao ključ. Pogledajte autentikaciju .
Brzo pokretanje → Otpremite datoteku, kreirajte zadatak, proverite status i preuzmite rezultate