Pregled platforme
OmniDoc API podržava radne točke s datotekama i sadržajem unutar jednog računa. Pozivatelj stvara resurse pomoću ključa API-a, a zatim koristi stabilne ID-ove koje dobije kako bi ih pretraživao, kombinirao, obrađivao ili preuzimao.
Model resursa
Section titled “Model resursa”| Resurs | Svrha |
|---|---|
| Dokument / Datoteka | Izvorni datoteke i unosi knjižnice datoteka u vlasništvu računa |
| Posao / Operacija | Asinhrona prevodilačka, obrada dokumenata ili audio i video zadaci |
| Artefakt | Rezultati koje posao pruža za pregled ili preuzimanje |
| Kreditna operacija | Zapis o tome što je jedna obračunljiva radnja naplaćena i refundirana |
Svaki resurs provjerava se u odnosu na vlasnički račun. Klijenti moraju čuvati samo javne ID-e i ne bi smjeli izvoditi zaključke o detaljima implementacije na temelju ID-ova, imena datoteka ili adresa za preuzimanje.
Uobičajeni tijek poziva
Section titled “Uobičajeni tijek poziva”- Kreirajte ili odaberite ulazni resurs.
- Provjerite ima li račun dovoljno kreditnih bodova: stanje se provjerava u odnosu na prag prije početka zadatka, a stvarna potrošnja obračunava se po završetku.
- Kreirajte zadatak s
Idempotency-Key. - Provjerite status zadatka; zadaci za prijevod datoteka također mogu koristiti SSE ili webhookove.
- Pročitajte rezultate i zapis o kreditu za ovaj posao.
Identitet
Section titled “Identitet”Vanjske integracije uvijek koriste API ključeve, s istim dozvolama kao i račun koji je kreirao taj ključ. Pogledajte autentifikaciju.
Brzi početak → Otpremite datoteku, kreirajte zadatak, provjerite njegov status i preuzmite rezultate