跳转到内容

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.

ResursSvrha
Dokument / DatotekaIzvorni datoteke i unosi knjižnice datoteka u vlasništvu računa
Posao / OperacijaAsinhrona prevodilačka, obrada dokumenata ili audio i video zadaci
ArtefaktRezultati koje posao pruža za pregled ili preuzimanje
Kreditna operacijaZapis 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.

  1. Kreirajte ili odaberite ulazni resurs.
  2. 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.
  3. Kreirajte zadatak s Idempotency-Key.
  4. Provjerite status zadatka; zadaci za prijevod datoteka također mogu koristiti SSE ili webhookove.
  5. Pročitajte rezultate i zapis o kreditu za ovaj posao.

Vanjske integracije uvijek koriste API ključeve, s istim dozvolama kao i račun koji je kreirao taj ključ. Pogledajte autentifikaciju.