跳转到内容

Ενσωματώστε τις διαδικασίες εγγράφων στην εφαρμογή σας

Από την ανέβαση ενός αρχείου μέχρι τη μετάφρασή του, τον έλεγχο της προόδου και τη λήψη του αποτελέσματος. Κάθε βήμα εξηγείται σύμφωνα με τη σειρά ενσωμάτωσης, με σημεία εισόδου για διαχείριση αρχείων, επεξεργασία εγγράφων και υπηρεσίες ήχου και βίντεο.

Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Αυθεντικοποίηση με κλειδί API · οι μεταφράσεις αρχείων εκτελούνται ως ασύγχρονες εργασίες

Αυτή η ιστοσελίδα περιγράφει την API cloud HTTP.

01 Ξεκινήστε με μία αίτηση που δεν κοστίζει πιστώσεις

Section titled “01 Ξεκινήστε με μία αίτηση που δεν κοστίζει πιστώσεις”

Βεβαιωθείτε ότι ο κωδικός σας και το δίκτυό σας λειτουργούν πριν από τη μεταφόρτωση αρχείων. Έλεγχος υπολοίπου δεν κοστίζει πόντους και δεν δημιουργεί έργο μετάφρασης.

  1. Λάβετε ένα API key

    Συνδεθείτε στην Κονσόλα API και δημιουργήστε μια προσβάσιμη προς το διαδίκτυο κλειδαριά που ξεκινά με sk_. Χρησιμοποιήστε ξεχωριστή κλειδαριά για κάθε εφαρμογή και ορίστε προϋπολογισμό.

    Ένας κλειδώρης λειτουργεί για τον λογαριασμό που τον δημιούργησε. Διατηρήστε τον στον διακομιστή και αναγνωρίστε τον από μια μεταβλητή περιβάλλοντος· μην τον εισάγετε ποτέ στον κώδικα πηγής της ιστοσελίδας ή σε δημόσιο αποθετήριο.

  2. Ελέγξτε το υπόλοιπο

    Ορίστε την μεταβλητή περιβάλλοντος OMNIDOC_API_KEY και στη συνέχεια εκτελέστε οποιοδήποτε από τα παρακάτω παραδείγματα. Η επιτυχία επιστρέφει JSON; το 401 σημαίνει ότι το key παρουσιάζει πρόβλημα και πρέπει να ελεγχθεί. Ποτέ μην εμφανίζετε το πλήρες key σε tickets, στιγμιότυπα οθόνης ή log.

    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"

02 Από αρχείο σε μετάφραση

Section titled “02 Από αρχείο σε μετάφραση”

Μια επιτυχημένη μεταφόρτωση σημαίνει μόνο ότι το αρχείο έχει αποθηκευτεί. Αφού δημιουργήσετε μια εργασία, περιμένετε να φτάσει σε τελική κατάσταση και στη συνέχεια αναφέρετε και κατεβάστε τα αποτελέσματά της.

ΒήμαΜέθοδος και δρόμοςΤι να διατηρήσετε
Ζητήστε ένα ανέβασμαPOST /upload/presignupload_url, upload_headers, finalize_token
Στείλτε το αρχείοPUT στο επιστρεφόμενο upload_urlΑπάντηση επιτυχίας· αυτό το αίτημα δεν περιέχει κλειδί API
Επιβεβαιώστε την ανάρτησηPOST /upload/finalizedocument.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 και πεδία αιτήματος μετάφρασης .

03 Βρείτε το τελικό σημείο για την εργασία σας

Section titled “03 Βρείτε το τελικό σημείο για την εργασία σας”

Κάθε καταχώρηση περιλαμβάνει τις διαδρομές, τα πεδία αιτήματος και παραδείγματα. Η κατάσταση υπηρεσίας του λογαριασμού σας και τα όρια του κλειδιού σας ισχύουν για όλα αυτά.

04 Αυθεντικοποίηση και ιδιοκτησία πόρων

Section titled “04 Αυθεντικοποίηση και ιδιοκτησία πόρων”

Ένας κλειδί API προσδιορίζει έναν λογαριασμό. Δεν αποτελεί δημόσιο συνθηματικό λήψης αρχείου.

Πρωτόκολλο ζήτησης

Χρησιμοποιήστε X-API-Key: sk_… ή Authorization: Bearer sk_…, ένα από τα δύο ανά αίτηση. Στείλτε Content-Type: application/json με σώματα JSON.

Τι μπορεί να φτάσει ένα κλειδί

Ένας κλειδίς προσβάσει μόνο τους πόρους που μπορεί να χρησιμοποιήσει ο λογαριασμός του· η κατάσταση της υπηρεσίας, ο προϋπολογισμός του κλειδιού και οι επιτρεπόμενες ρυθμίσεις μετάφρασης εξακολουθούν να ισχύουν. Οι αλλαγές στον λογαριασμό και η δημιουργία, η περιστροφή ή η ανάκληση κλειδιών γίνονται στην κονσόλα.

Δείτε αυθεντικοποίηση, προϋπολογισμοί και εναλλαγή και υπηρεσίες και άδειες .

05 Ενσωμάτωση διαχείρισης αποτυχίας συγκρότησης στην ενσωμάτωση

Section titled “05 Ενσωμάτωση διαχείρισης αποτυχίας συγκρότησης στην ενσωμάτωση”

Η παράταση χρόνου δεν σημαίνει ότι η εργασία δεν δημιουργήθηκε. Διαχωρίστε τα επαναλήψιμα σφάλματα από τις αιτήσεις που χρειάζονται διόρθωση, ώστε να μην υποβληθεί ή επεξεργαστεί κάτι δύο φορές.

  • Ιδιότητα ισοδύναμης δημιουργίας : δημιουργήστε ένα Idempotency-Key για κάθε νέα λειτουργία δημιουργίας· όταν επαναλάβετε την ίδια λειτουργία, χρησιμοποιήστε ξανά το αρχικό κλειδί και ακριβώς το ίδιο σώμα αίτησης. Οι λειτουργίες τεκμηρίωσης, οι εργασίες πολυμέσων και η δημιουργία φωνής απαιτούν το κλειδί· για άλλες ολοκληρωμένες διεπαφές δημιουργίας, βλέπε τις σχετικές σελίδες αναφοράς.
  • Ασύγχρονες ειδοποιήσεις : η ανάκτηση δεδομένων με polling είναι κατάλληλη για μια πρώτη ενσωμάτωση· για συνεχή παρακολούθηση της πορείας χρησιμοποιήστε SSE , και για να λαμβάνετε τις τελικές καταστάσεις στο παρασκήνιο χρησιμοποιήστε ένα webhook .
ΚατάστασηΕλέγξτε πρώταΤι να κάνετε
401 / 403Κλειδί, δικαιώματα, ιδιοκτησία πόρωνΔιορθώστε τα διαπιστευτήρια ή τις δικαιοδοσίες· μην επαναλάβετε ανεπιφύλακτα την προσπάθεια.
402Διαθέσιμες πιστώσειςΚάντε ανανέωση προσώπου και στη συνέχεια υποβάλετε ξανά
409Κλειδί και σώμα ιδεμποτέντικης ενέργειας, κατάσταση πόρουΕλέγξτε την αρχική λειτουργία πριν ξεκινήσετε μια νέα
422Σφάλματα πεδίου στην απάντησηΔιορθώστε τις παραμέτρους ή το αρχείο
429Επιχείρηση code και Retry-AfterΤα όρια συχνότητας και ουράς μπορούν να περιμένουν την εξάντλησή τους· πρέπει πρώτα να αυξηθεί το προϋπολογισμός των προσκλήσεων που έχει εξαντληθεί.
5xxΠροσωρινό σφάλμα υπηρεσίαςΠεριορισμένη εκθετική αναβολή; διατηρήστε το κλειδί ιδεμποτενσίας για αιτήσεις δημιουργίας

Διατηρήστε το πεδίο response header X-Request-Id, την ώρα αίτησης και τη διαδρομή για αντιμετώπιση προβλημάτων· ποτέ μην καταγράφετε το πλήρες key. Όλοι οι κωδικοί σφάλματος και τα παραδείγματα επαναλήψεων βρίσκονται στην αναφορά σφάλματος .

06 Ελέγξτε πώς λειτουργεί η χρέωση πριν την ενσωμάτωση

Section titled “06 Ελέγξτε πώς λειτουργεί η χρέωση πριν την ενσωμάτωση”

Χωρίς πιστώσεις

Η ανεβασμάτων, ο έλεγχος εργασιών, η λήψη αποτελεσμάτων και η ανάγνωση των αρχείων υπολοίπου και εκκαθάρισης δεν κοστίζουν πόντους· το ίδιο ισχύει για τα γλωσσάρια, τα έργα, τις ετικέτες, την αναζήτηση και την κοινή χρήση.

Χρεώνεται βάσει χρήσης

Η μετάφραση αρχείων, τα εργαλεία εγγράφων, η άμεση μετάφραση και οι υπηρεσίες ήχου και βίντεο χρεώνονται με βάση την πραγματική χρήση· η δημιουργία μιας εργασίας δεν αποτελεί την τελική χρέωση.

Πριν ξεκινήσει μια εργασία, ελέγχεται μόνο το όριο υπολοίπου· μετά την ολοκλήρωσή της, χρεώνεται η πραγματική χρήση. Εάν το υπόλοιπο είναι ανεπαρκές, η διαφορά καταχωρείται ως χρέος, και οι πιστώσεις που λαμβάνονται αργότερα εξοφλούν πρώτα αυτό. Μπορείτε να εξομοιώσετε χρεώσεις και επιστροφές χρημάτων ανά εργασία ή ανά πιστωτική συναλλαγή. Όταν ο προϋπολογισμός ενός κλειδιού εξαντληθεί, μπορείτε ακόμα να αναζητήσετε τις εργασίες, τα αποτελέσματα και τα αρχεία που σχετίζονται με αυτό το κλειδί.