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.
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.
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.
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.
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.
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());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.
| Pas | Metodă și cale | Ce trebuie păstrat |
|---|---|---|
| Cereți încărcarea | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Trimite fișierul | PUT la upload_url returnat | Răspuns de succes; această cerere nu conține niciun cheie API |
| Confirma încărcarea | POST /upload/finalize | document.id |
| Creați o traducere | POST /jobs | Job id |
| Verificați starea | GET /jobs/{job_id} | completed sau failed |
| Listează rezultatele | GET /artifacts?job_id={job_id} | ID-uri și formate de artefacte |
| Descarcă un rezultat | GET /artifacts/{artifact_id}/download | Byte-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 .
Fiecare înregistrare listează calea, câmpurile de cerere și exemple. Starea serviciului contului dvs. și limitele cheii dvs. se aplică tuturor acestora.
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 .
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.
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.| Stare | Verificați mai întâi | Ce să fac |
|---|---|---|
401 / 403 | Cheie, permisiuni, proprietatea resurselor | Corectați credențialele sau permisiunile; nu relansați operațiunea fără a verifica. |
402 | Credite disponibile | Completați suma, apoi trimiteți din nou |
409 | Cheia și corpul idempotenței, starea resursei | Verificați operația inițială înainte de a începe una nouă |
422 | Erori de câmp în răspuns | Corectați parametrii sau fișierul |
429 | Business code și Retry-After | Limitările de rată și de coadă pot fi așteptate; un buget de chei epuizat trebuie întâi crescut. |
5xx | Eroare temporară a serviciului | Backoff 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 .
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.