Πρωτόκολλο ζήτησης
Χρησιμοποιήστε X-API-Key: sk_… ή Authorization: Bearer sk_…, ένα από τα δύο ανά αίτηση. Στείλτε Content-Type: application/json με σώματα JSON.
Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Αυθεντικοποίηση με κλειδί API · οι μεταφράσεις αρχείων εκτελούνται ως ασύγχρονες εργασίες
Αυτή η ιστοσελίδα περιγράφει την API cloud HTTP.
Βεβαιωθείτε ότι ο κωδικός σας και το δίκτυό σας λειτουργούν πριν από τη μεταφόρτωση αρχείων. Έλεγχος υπολοίπου δεν κοστίζει πόντους και δεν δημιουργεί έργο μετάφρασης.
Λάβετε ένα API key
Συνδεθείτε στην Κονσόλα API και δημιουργήστε μια προσβάσιμη προς το διαδίκτυο κλειδαριά που ξεκινά με sk_. Χρησιμοποιήστε ξεχωριστή κλειδαριά για κάθε εφαρμογή και ορίστε προϋπολογισμό.
Ένας κλειδώρης λειτουργεί για τον λογαριασμό που τον δημιούργησε. Διατηρήστε τον στον διακομιστή και αναγνωρίστε τον από μια μεταβλητή περιβάλλοντος· μην τον εισάγετε ποτέ στον κώδικα πηγής της ιστοσελίδας ή σε δημόσιο αποθετήριο.
Ελέγξτε το υπόλοιπο
Ορίστε την μεταβλητή περιβάλλοντος OMNIDOC_API_KEY και στη συνέχεια εκτελέστε οποιοδήποτε από τα παρακάτω παραδείγματα. Η επιτυχία επιστρέφει JSON; το 401 σημαίνει ότι το key παρουσιάζει πρόβλημα και πρέπει να ελεγχθεί. Ποτέ μην εμφανίζετε το πλήρες key σε tickets, στιγμιότυπα οθόνης ή log.
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());Μια επιτυχημένη μεταφόρτωση σημαίνει μόνο ότι το αρχείο έχει αποθηκευτεί. Αφού δημιουργήσετε μια εργασία, περιμένετε να φτάσει σε τελική κατάσταση και στη συνέχεια αναφέρετε και κατεβάστε τα αποτελέσματά της.
| Βήμα | Μέθοδος και δρόμος | Τι να διατηρήσετε |
|---|---|---|
| Ζητήστε ένα ανέβασμα | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Στείλτε το αρχείο | PUT στο επιστρεφόμενο upload_url | Απάντηση επιτυχίας· αυτό το αίτημα δεν περιέχει κλειδί API |
| Επιβεβαιώστε την ανάρτηση | POST /upload/finalize | document.id |
| Δημιουργήστε μια μετάφραση | POST /jobs | Εργασία id |
| Ελέγξτε την κατάσταση | GET /jobs/{job_id} | completed ή failed |
| Παρουσιάστε τα αποτελέσματα | GET /artifacts?job_id={job_id} | Ταυτότητες και μορφές αντικειμένων |
| Λήψη αποτελέσματος | GET /artifacts/{artifact_id}/download | Αρχείο μπάιτ και όνομα αρχείου απόκρισης |
Για την άμεση ανάρτηση, στείλτε το upload_headers από τον διακομιστή ακριβώς όπως επιστρέφεται και ποτέ μη στείλετε X-API-Key στη διεύθυνση αποθήκευσης. Εάν η διεύθυνση ανάρτησης λήξει ή η μεταφορά αποτύχει, ζητήστε μια νέα. Λεπτομέρειες: πρωτόκολλο ανάρτησης , γρήγορη εκκίνηση , πλήρης ροή εργασίας Node.js και πεδία αιτήματος μετάφρασης .
Κάθε καταχώρηση περιλαμβάνει τις διαδρομές, τα πεδία αιτήματος και παραδείγματα. Η κατάσταση υπηρεσίας του λογαριασμού σας και τα όρια του κλειδιού σας ισχύουν για όλα αυτά.
Ένας κλειδί API προσδιορίζει έναν λογαριασμό. Δεν αποτελεί δημόσιο συνθηματικό λήψης αρχείου.
Πρωτόκολλο ζήτησης
Χρησιμοποιήστε X-API-Key: sk_… ή Authorization: Bearer sk_…, ένα από τα δύο ανά αίτηση. Στείλτε Content-Type: application/json με σώματα JSON.
Τι μπορεί να φτάσει ένα κλειδί
Ένας κλειδίς προσβάσει μόνο τους πόρους που μπορεί να χρησιμοποιήσει ο λογαριασμός του· η κατάσταση της υπηρεσίας, ο προϋπολογισμός του κλειδιού και οι επιτρεπόμενες ρυθμίσεις μετάφρασης εξακολουθούν να ισχύουν. Οι αλλαγές στον λογαριασμό και η δημιουργία, η περιστροφή ή η ανάκληση κλειδιών γίνονται στην κονσόλα.
Δείτε αυθεντικοποίηση, προϋπολογισμοί και εναλλαγή και υπηρεσίες και άδειες .
Η παράταση χρόνου δεν σημαίνει ότι η εργασία δεν δημιουργήθηκε. Διαχωρίστε τα επαναλήψιμα σφάλματα από τις αιτήσεις που χρειάζονται διόρθωση, ώστε να μην υποβληθεί ή επεξεργαστεί κάτι δύο φορές.
Idempotency-Key για κάθε νέα λειτουργία δημιουργίας· όταν επαναλάβετε την ίδια λειτουργία, χρησιμοποιήστε ξανά το αρχικό κλειδί και ακριβώς το ίδιο σώμα αίτησης. Οι λειτουργίες τεκμηρίωσης, οι εργασίες πολυμέσων και η δημιουργία φωνής απαιτούν το κλειδί· για άλλες ολοκληρωμένες διεπαφές δημιουργίας, βλέπε τις σχετικές σελίδες αναφοράς.| Κατάσταση | Ελέγξτε πρώτα | Τι να κάνετε |
|---|---|---|
401 / 403 | Κλειδί, δικαιώματα, ιδιοκτησία πόρων | Διορθώστε τα διαπιστευτήρια ή τις δικαιοδοσίες· μην επαναλάβετε ανεπιφύλακτα την προσπάθεια. |
402 | Διαθέσιμες πιστώσεις | Κάντε ανανέωση προσώπου και στη συνέχεια υποβάλετε ξανά |
409 | Κλειδί και σώμα ιδεμποτέντικης ενέργειας, κατάσταση πόρου | Ελέγξτε την αρχική λειτουργία πριν ξεκινήσετε μια νέα |
422 | Σφάλματα πεδίου στην απάντηση | Διορθώστε τις παραμέτρους ή το αρχείο |
429 | Επιχείρηση code και Retry-After | Τα όρια συχνότητας και ουράς μπορούν να περιμένουν την εξάντλησή τους· πρέπει πρώτα να αυξηθεί το προϋπολογισμός των προσκλήσεων που έχει εξαντληθεί. |
5xx | Προσωρινό σφάλμα υπηρεσίας | Περιορισμένη εκθετική αναβολή; διατηρήστε το κλειδί ιδεμποτενσίας για αιτήσεις δημιουργίας |
Διατηρήστε το πεδίο response header X-Request-Id, την ώρα αίτησης και τη διαδρομή για αντιμετώπιση προβλημάτων· ποτέ μην καταγράφετε το πλήρες key. Όλοι οι κωδικοί σφάλματος και τα παραδείγματα επαναλήψεων βρίσκονται στην αναφορά σφάλματος .
Χωρίς πιστώσεις
Η ανεβασμάτων, ο έλεγχος εργασιών, η λήψη αποτελεσμάτων και η ανάγνωση των αρχείων υπολοίπου και εκκαθάρισης δεν κοστίζουν πόντους· το ίδιο ισχύει για τα γλωσσάρια, τα έργα, τις ετικέτες, την αναζήτηση και την κοινή χρήση.
Χρεώνεται βάσει χρήσης
Η μετάφραση αρχείων, τα εργαλεία εγγράφων, η άμεση μετάφραση και οι υπηρεσίες ήχου και βίντεο χρεώνονται με βάση την πραγματική χρήση· η δημιουργία μιας εργασίας δεν αποτελεί την τελική χρέωση.
Πριν ξεκινήσει μια εργασία, ελέγχεται μόνο το όριο υπολοίπου· μετά την ολοκλήρωσή της, χρεώνεται η πραγματική χρήση. Εάν το υπόλοιπο είναι ανεπαρκές, η διαφορά καταχωρείται ως χρέος, και οι πιστώσεις που λαμβάνονται αργότερα εξοφλούν πρώτα αυτό. Μπορείτε να εξομοιώσετε χρεώσεις και επιστροφές χρημάτων ανά εργασία ή ανά πιστωτική συναλλαγή. Όταν ο προϋπολογισμός ενός κλειδιού εξαντληθεί, μπορείτε ακόμα να αναζητήσετε τις εργασίες, τα αποτελέσματα και τα αρχεία που σχετίζονται με αυτό το κλειδί.