01
कुंजी बनाएँ
केवल उन क्षमताओं का चयन करें जिनकी आपकी सेवा को आवश्यकता है और रहस्य को सर्वर-साइड सीक्रेट मैनेजर में संग्रहीत करें।
API reference · v1JSON + multipart
कढ़ाई को शामिल करें अपने उत्पाद में।
निजी इमेज डिजिटाइजिंग और वास्तविक मशीन-फाइल रूपांतरण के लिए व्यावहारिक REST API। यह पृष्ठ पूर्ण क्विकस्टार्ट, एंडपॉइंट संदर्भ और त्रुटि मार्गदर्शिका है।
बेस URL
https://embroideryfileconverter.com/api/developer/v1
प्रमाणीकरण
Bearer कुंजी
दर
60/min
जॉब्स
Async
कुंजियाँ स्कोप्ड हैं, समाप्त होती हैं, तुरंत रद्द की जा सकती हैं और केवल एक बार दिखाई जाती हैं। इन्हें अपने सर्वर पर रखें—कभी भी ब्राउज़र या मोबाइल क्लाइंट कोड में न भेजें।
क्विकस्टार्ट
तीन चरणों में आपकी पहली जॉब।
02
स्रोत भेजें
वर्कफ़्लो, आउटपुट फ़ॉर्मेट और एक निजी स्रोत फ़ाइल के साथ मल्टीपार्ट फॉर्म डेटा POST करें।
03
जॉब पोल करें
स्थिति पूर्ण या विफल होने तक लौटाए गए वर्कफ़्लो और जॉब ID का उपयोग करें।
रूपांतरण जॉब बनाएँ · 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:readusage:readjobs:readjobs:writeAuthorization हेडर
Authorization: Bearer efc_live_...
Accept: application/jsonकेवल सर्वर-साइड
डेवलपर कुंजी को वेब पेज, वितरित डेस्कटॉप बाइनरी या मोबाइल ऐप में एम्बेड न करें। अपने बैकएंड के माध्यम से अनुरोधों को प्रॉक्सी करें।
प्रतिनिधि उपयोगकर्ता पहुँच चाहिए?
AI क्लाइंट्स को डेवलपर API कुंजी प्राप्त करने के बजाय OAuth और PKCE के साथ MCP का उपयोग करना चाहिए।
POST /jobs
वह वर्कफ़्लो चुनें जो स्रोत से मेल खाता हो।
मौजूदा मशीन फ़ाइल
PES, DST, JEF या कोई अन्य पठनीय कढ़ाई फ़ॉर्मेट अपलोड करें और एक अलग लिखने योग्य आउटपुट चुनें।
- आवश्यक
- workflow, format, file
- अधिकतम फ़ाइल
- 50 MB
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आउटपुट और चेतावनियाँ निरीक्षण करेंfailedfailureCode और 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. अनलॉक एंडपॉइंट कॉल करने से सदस्यता भत्ता या मौजूदा प्रोसेसिंग क्रेडिट्स खर्च हो सकते हैं। आंतरिक खाते बिना शुल्क अनलॉक कर सकते हैं। यह चेकआउट खोलता नहीं है या क्रेडिट्स नहीं खरीदता।एंडपॉइंट संदर्भ
पूर्ण v1 सतह।
GET
/formatsपठनीय स्रोत, लिखने योग्य आउटपुट और संगतता चेतावनियाँ।
formats:readGET
/usageपूर्वावलोकन भत्ता, क्रेडिट, वर्कफ़्लो लागत और रीसेट तिथियाँ।
usage:readGET
/jobsखाते के 50 सबसे हाल के निजी प्रसंस्करण जॉब्स।
jobs:readPOST
/jobsरूपांतरण या छवि-डिजिटाइजिंग पूर्वावलोकन जॉब बनाएँ।
jobs:writeGET
/jobs/conversion/{id}एक स्वामित्व वाले रूपांतरण जॉब और उसके आउटपुट का निरीक्षण करें।
jobs:readGET
/jobs/digitising/{id}एक स्वामित्व वाले डिजिटाइजिंग जॉब और उसके आउटपुट का निरीक्षण करें।
jobs:readPOST
/jobs/{workflow}/{id}/retryएक असफल जॉब को फिर से कतारबद्ध करें जबकि उसका निजी स्रोत अभी भी मौजूद है।
jobs:writePOST
/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 उदाहरण शामिल हैं।
सहायता चाहिए? डेवलपर सहायता से संपर्क करें
OpenAPI विवरण डाउनलोड करें