Αναφορά API · v1JSON + multipart

Ενσωμάτωση κεντήματος σε το προϊόν σας.

Πρακτικό REST API για ιδιωτική ψηφιοποίηση εικόνας και πραγματική μετατροπή αρχείου μηχανής. Αυτή η σελίδα περιέχει τον πλήρη οδηγό γρήγορης εκκίνησης, αναφοράς τελικών σημείων και σφαλμάτων.

Λήψη κλειδιού API OpenAPI 3.1

Βασική διεύθυνση URL

https://embroideryfileconverter.com/api/developer/v1

Έλεγχος ταυτότητας

Κλειδί Bearer

Ρυθμός

60/min

Εργασίες

Ασύγχρονη

Τα κλειδιά έχουν εύρος, λήγουν, μπορούν να ανακληθούν άμεσα και εμφανίζονται μόνο μία φορά. Φυλάξτε τα στον διακομιστή σας—μην τα στέλνετε ποτέ σε κώδικα προγράμματος περιήγησης ή κινητής εφαρμογής.

Επισκόπηση Γρήγορη εκκίνηση Έλεγχος ταυτότητας Δημιουργία εργασίας Κύκλος ζωής εργασίας Αναφορά τελικών σημείων Σφάλματα & όρια

Γρήγορη εκκίνηση

Η πρώτη σας εργασία σε τρία βήματα.

Δημιουργία κλειδιού

Επιλέξτε μόνο τις δυνατότητες που χρειάζεται η υπηρεσία σας και αποθηκεύστε το μυστικό σε διαχειριστή μυστικών στον διακομιστή.

Αποστολή πηγής

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

Δημοσκόπηση εργασίας

Χρησιμοποιήστε τη ροή εργασίας και το αναγνωριστικό εργασίας που επιστράφηκαν μέχρι η κατάσταση να γίνει ολοκληρωμένη ή αποτυχημένη.

Δημιουργία εργασίας μετατροπής · Shell

curl -X POST https://embroideryfileconverter.com/api/developer/v1/jobs \
  -H "Authorization: Bearer $EFC_API_KEY" \
  -H "Accept: application/json" \
  -F "workflow=conversion" \
  -F "format=dst" \
  -F "[email protected]"

Έλεγχος ταυτότητας

Κλειδιά Bearer με εύρος.

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

formats:read

usage:read

jobs:read

jobs:write

Κεφαλίδα Authorization

Authorization: Bearer efc_live_...
Accept: application/json

Μόνο στον διακομιστή

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

Χρειάζεστε εκχωρημένη πρόσβαση χρήστη;

Οι πελάτες AI πρέπει να χρησιμοποιούν MCP με OAuth και PKCE αντί να λαμβάνουν κλειδί API προγραμματιστή.

POST /jobs

Επιλέξτε τη ροή εργασίας που ταιριάζει με την πηγή.

workflow=conversion

Υπάρχον αρχείο μηχανής

Ανεβάστε PES, DST, JEF ή άλλη αναγνώσιμη μορφή κεντήματος και επιλέξτε διαφορετική εγγράψιμη έξοδο.

Απαιτούνται: workflow, format, file
Μέγιστο αρχείο: 50 MB

workflow=digitising

Έργο τέχνης JPG, PNG, SVG ή WebP

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

Πρόσθετα πεδία: width_mm, colour_count
Έγκυρα εύρη: 10–300 mm · 1–24 χρώματα
Μέγιστο αρχείο: 20 MB

Μεμονωμένα αρχεία και παρτίδες

Χρησιμοποιήστε file για μία πηγή ή files[] για έως 10 πηγές. Η περιορισμένη δωρεάν επεξεργασία μπορεί να δέχεται ένα αρχείο ανά αίτημα. Κάθε παρτίδα χρησιμοποιεί μία κοινή ροή εργασίας και μορφή εξόδου.

202 Accepted

{
  "message": "Processing started.",
  "job": {
    "id": "01JEXAMPLEJOBID000000000",
    "status": "queued",
    "workflow": "conversion"
  },
  "jobs": [
    {
      "id": "01JEXAMPLEJOBID000000000",
      "status": "queued",
      "workflow": "conversion"
    }
  ],
  "freeUsage": {
    "previewRemaining": 2,
    "creditBalance": 0
  }
}

Η δημιουργία είναι ασύγχρονη

Το HTTP 202 σημαίνει ότι η ιδιωτική εργασία έγινε δεκτή, όχι ότι το αρχείο μηχανής είναι έτοιμο. Διατηρήστε και τα δύο job.id και job.workflow; η ροή εργασίας επιλέγει τη διαδρομή κατάστασης.

queuedΑναμονή για εργάτη

processingΟ κινητήρας εκτελείται

completedΕπιθεώρηση εξόδων και προειδοποιήσεων

failedΑνάγνωση failureCode και failureReason

Δημοσκόπηση και αρχεία

Διαβάστε το αποτέλεσμα, όχι μόνο την κατάσταση.

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

Λήψη εργασίας επεξεργασίας · Shell

curl https://embroideryfileconverter.com/api/developer/v1/jobs/conversion/01JEXAMPLEJOBID000000000 \
  -H "Authorization: Bearer $EFC_API_KEY" \
  -H "Accept: application/json"

Μετρήσεις

Αριθμός βελονιών, διαστάσεις και μετρήσεις ειδικές για τον κινητήρα.

Προειδοποιήσεις

Σημειώσεις συμβατότητας ή παραγωγής που πρέπει να εμφανίζει το UI σας.

Ιδιωτικά αρχεία

Οι υπογεγραμμένες διευθύνσεις URL διαρκούν 10 λεπτά και εξακολουθούν να επιβάλλουν ιδιοκτησία και κατάσταση ξεκλειδώματος.

Το ξεκλείδωμα μπορεί να καταναλώσει δικαίωμα

Πρώτα επιθεωρήστε job.unlock ή GET /usage. Η κλήση του endpoint ξεκλειδώματος μπορεί να καταναλώσει υπόλοιπο συνδρομής ή υπάρχουσες πιστώσεις επεξεργασίας. Εσωτερικοί λογαριασμοί μπορούν να ξεκλειδώσουν χωρίς χρέωση. Δεν ανοίγει οθόνη αγοράς ούτε αγοράζει πιστώσεις.

Αναφορά τελικών σημείων

Η πλήρης επιφάνεια v1.

OpenAPI JSON

GET/formats

Αναγνώσιμες πηγές, εγγράψιμες έξοδοι και προειδοποιήσεις συμβατότητας.

formats:read

GET/usage

Όριο προεπισκοπήσεων, πιστώσεις, κόστος ροών εργασίας και ημερομηνίες επαναφοράς.

usage:read

GET/jobs

Οι 50 πιο πρόσφατες ιδιωτικές εργασίες επεξεργασίας του λογαριασμού.

jobs:read

POST/jobs

Δημιουργία εργασίας προεπισκόπησης μετατροπής ή ψηφιοποίησης εικόνας.

jobs:write

GET/jobs/conversion/{id}

Επιθεώρηση μίας εργασίας μετατροπής που ανήκει και των εξόδων της.

jobs:read

GET/jobs/digitising/{id}

Επιθεώρηση μίας εργασίας ψηφιοποίησης που ανήκει και των εξόδων της.

jobs:read

POST/jobs/{workflow}/{id}/retry

Επανατοποθέτηση σε ουρά αποτυχημένης εργασίας ενώ η ιδιωτική πηγή της υπάρχει ακόμα.

jobs:write

POST/jobs/{workflow}/{id}/unlock

Ξεκλείδωμα ολοκληρωμένης εργασίας με χρήση ορίου ή υπαρχουσών πιστώσεων.

jobs:write

Αποκρίσεις λίστας

GET /formats επιστρέφει data[] και artworkInputs[]. GET /jobs επιστρέφει data[] συν freeUsage και περιορίζεται στις 50 πιο πρόσφατες εργασίες.

Αποκρίσεις επανάληψης

Η επανάληψη δέχεται μόνο failed εργασία της οποίας η πηγή δεν έχει λήξει. Μια επιτυχής επανάληψη επιστρέφει HTTP 202 με την εργασία επαναρυθμισμένη σε queued.

Σφάλματα και όρια ρυθμού

Αποτυχία σαφώς. Επανάληψη σκόπιμα.

401

Απουσία, μη έγκυρο, ληγμένο ή ανακληθέν κλειδί

403

Απουσία δυνατότητας ή ο πόρος ανήκει σε άλλο χρήστη

404

Η εργασία ή το ιδιωτικό αρχείο δεν βρέθηκε

409

Η κατάσταση εργασίας δεν επιτρέπει αυτή την ενέργεια

410

Η μεταφόρτωση πηγής έχει λήξει

422

Μη έγκυρα πεδία, αρχείο, μορφή ή ανεπαρκές πηλίκο

429

Υπέρβαση ορίου ρυθμού

Σφάλμα επικύρωσης 422

{
  "message": "The format field is invalid.",
  "errors": {
    "format": [
      "Choose an output format different from every detected source format."
    ]
  }
}

60 αιτήματα ανά λεπτό

Το γενικό όριο ισχύει ανά κλειδί API, με ξεχωριστό ανώτατο όριο δικτύου. Οι διαδρομές μεταφόρτωσης, επεξεργασίας και ξεκλειδώματος έχουν αυστηρότερους ελέγχους κατάχρησης.

Χειρισμός HTTP 429

Σεβασμός Retry-After και χρήση εκθετικής οπισθοχώρησης με jitter. Μην κάνετε συνεχώς δημοσκόπηση ολοκληρωμένων ή αποτυχημένων εργασιών.

Δημιουργία για πράκτορα AI;

Χρησιμοποιήστε OAuth + MCP, όχι κλειδί API.

Ο οδηγός πράκτορα περιλαμβάνει ρύθμιση σύνδεσης, διευθύνσεις URL ανακάλυψης, OAuth PKCE, κάθε σχήμα εργαλείου και έτοιμα παραδείγματα JSON-RPC για αντιγραφή.

Άνοιγμα τεκμηρίωσης MCP

Χρειάζεστε βοήθεια; Επικοινωνία με υποστήριξη προγραμματιστών

Λήψη περιγραφής OpenAPI