Sari la conținut

Integrați fluxurile de lucru cu documente în aplicația dumneavoastră

De la încărcarea unui fișier până la traducerea acestuia, verificarea progresului și descărcarea rezultatului. Fiecare etapă este explicată în ordinea integrării, cu puncte de acces pentru gestionarea fișierelor, procesarea documentelor și serviciile audio și video.

Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Autentificare prin cheie API · execuții de traducere a fișierelor ca sarcini asincrone

Acest site descrie API-ul cloud HTTP.

01 Începeți cu o cerere care nu costă niciun credit

Section titled “01 Începeți cu o cerere care nu costă niciun credit”

Verificați că cheia și rețeaua funcționează înainte de a încărca fișierele. Verificarea soldului nu consumă credit și nu generează nicio sarcină de traducere.

  1. Obțineți o cheie API

    Autentificați-vă în consola API și creați o cheie care începe cu sk_. Folosiți o cheie separată pentru fiecare aplicație și atribuiți-i un buget.

    O cheie este valabilă pentru contul care a creat-o. Păstrați-o pe server și accesați-o dintr-o variabilă de mediu; nu o includeți niciodată în codul sursă al paginii web sau într-un depozit public.

  2. Verifica balanța

    Setați variabila de mediu OMNIDOC_API_KEY, apoi executați oricare dintre exemplele de mai jos. Rezultatul „Success” returnează JSON; 401 înseamnă că cheia prezintă o problemă și trebuie verificată. Nu afișați niciodată cheia completă în bilete, capturi de ecran sau registre.

    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"

O încărcare reușită înseamnă doar că fișierul a fost stocat. După crearea unei sarcini, așteptați până când aceasta atinge un statut final, apoi listați și descărcați rezultatele.

PasMetodă și caleCe trebuie păstrat
Cereți încărcareaPOST /upload/presignupload_url, upload_headers, finalize_token
Trimite fișierulPUT la upload_url returnatRăspuns de succes; această cerere nu conține niciun cheie API
Confirma încărcareaPOST /upload/finalizedocument.id
Creați o traducerePOST /jobsJob id
Verificați stareaGET /jobs/{job_id}completed sau failed
Listează rezultateleGET /artifacts?job_id={job_id}ID-uri și formate de artefacte
Descarcă un rezultatGET /artifacts/{artifact_id}/downloadByte-ii fișierului și numele fișierului de răspuns

Pentru încărcarea directă, trimiteți upload_headers de la server exact așa cum a fost returnat și nu trimiteți niciodată X-API-Key către adresa de stocare. Dacă adresa de încărcare expiră sau transferul eșuează, solicitați una nouă. Detalii: protocol de încărcare , start rapid , flux de lucru complet Node.js și câmpuri de solicitare a traducerii .

03 Găsiți capătul pentru sarcina dumneavoastră

Section titled “03 Găsiți capătul pentru sarcina dumneavoastră”

Fiecare înregistrare listează calea, câmpurile de cerere și exemple. Starea serviciului contului dvs. și limitele cheii dvs. se aplică tuturor acestora.

04 Autentificare și proprietatea resurselor

Section titled “04 Autentificare și proprietatea resurselor”

O cheie API identifică un cont. Nu este un parolă publică de descărcare pentru un fișier.

Cerere header

Utilizați X-API-Key: sk_… sau Authorization: Bearer sk_…, unul dintre cele două pentru fiecare cerere. Trimiteți Content-Type: application/json împreună cu corpuri JSON.

Ce poate atinge o cheie

O cheie accesează doar resursele pe care contul său le poate utiliza; starea serviciului, bugetul cheii și setările de traducere permise rămân aplicabile. Modificările la nivel de cont, precum și crearea, rotația sau revocarea cheilor se efectuează în console.

Vezi autentificare, bugete și rotație și servicii și permisiuni .

05 Integrează gestionarea erorilor de compilare în procesul de integrare

Section titled “05 Integrează gestionarea erorilor de compilare în procesul de integrare”

O expirare a temporizatorului nu înseamnă că sarcina nu a fost creată. Distinge erorile reîncercabile de cererile care necesită remediere, astfel încât nimic să nu fie trimis sau procesat de două ori.

  • Creare idempotentă : generați un Idempotency-Key pentru fiecare operație de creare nouă; atunci când reîncercați aceeași operație, reutilizați cheia originală și exact același corp al cererii. Operațiile de documentare, sarcinile media și crearea vocală necesită cheia; pentru celelalte puncte de terminare de creare, consultați paginile de referință corespunzătoare.
  • Notificări asincrone : polularea este adecvată pentru o primă integrare; pentru monitorizarea continuă a progresului folosiți SSE , iar pentru a primi statele finale în background folosiți un webhook .
StareVerificați mai întâiCe să fac
401 / 403Cheie, permisiuni, proprietatea resurselorCorectați credențialele sau permisiunile; nu relansați operațiunea fără a verifica.
402Credite disponibileCompletați suma, apoi trimiteți din nou
409Cheia și corpul idempotenței, starea resurseiVerificați operația inițială înainte de a începe una nouă
422Erori de câmp în răspunsCorectați parametrii sau fișierul
429Business code și Retry-AfterLimitările de rată și de coadă pot fi așteptate; un buget de chei epuizat trebuie întâi crescut.
5xxEroare temporară a serviciuluiBackoff exponențial limitat; păstrați cheia de idempotență pentru cererile de creare

Păstrați capitolul de răspuns X-Request-Id, ora cererii și calea pentru rezolvarea problemelor; nu înregistrați niciodată cheia completă. Toate codurile de eroare și exemplele de retried sunt în referința eroare .

06 Verificați cum funcționează facturarea înainte de a integra

Section titled “06 Verificați cum funcționează facturarea înainte de a integra”

Fără credite

Încărcarea, verificarea sarcinilor, descărcarea rezultatelor și citirea soldului și a înregistrărilor de consemnare nu consumă credit; nici glosarele, proiectele, etichetele, căutarea și partajarea.

Facturat după utilizare

Traducerea fișierelor, instrumentele de documentare, traducerea instantanee și serviciile audio și video sunt facturate în funcție de utilizarea efectivă; crearea unei sarcini nu reprezintă costul final.

Înainte de începerea unei sarcini, se verifică doar pragul de bilanț; după finalizarea acesteia, se facturează consumul efectiv. Dacă balanța este insuficientă, diferența se înregistrează ca datorie, iar creditele sosite ulterior o acoperă înainte. Puteți reconcilia facturi și rambursări pe fiecare sarcină sau pe fiecare operațiune de creditare. Atunci când bugetul unei chei se epuizează, puteți totuși consulta sarcinile, rezultatele și înregistrările asociate acelei chei.