# Embroidery File Converter डेवलपर API

कैनोनिकल पेज: https://embroideryfileconverter.com/hi/developers

छवि डिजिटाइजिंग, फ़ाइल रूपांतरण, जॉब स्थिति, मान्य आउटपुट और हस्ताक्षरित डाउनलोड के लिए निजी REST API के साथ कढ़ाई वर्कफ़्लो बनाएं।

## सही एकीकरण चुनें

- बैकएंड, SaaS उत्पाद, ईकॉमर्स वर्कफ़्लो, ऑटोमेशन या सर्वर-साइड एप्लिकेशन के लिए इस पेज पर REST API का उपयोग करें।
- जब कोई असिस्टेंट OAuth के माध्यम से उपयोगकर्ता की ओर से कार्य करे तो [AI एजेंट और MCP दस्तावेज़](https://embroideryfileconverter.com/hi/ai-agents) का उपयोग करें।

डेवलपर API कुंजी ब्राउज़र JavaScript, मोबाइल एप्लिकेशन या वितरित डेस्कटॉप बाइनरी में न डालें।

## बेस URL और प्रमाणीकरण

- बेस URL: `https://embroideryfileconverter.com/api/developer/v1`
- प्रमाणीकरण: `Authorization: Bearer efc_live_...`
- जॉब कंटेंट टाइप: `multipart/form-data`
- सामान्य डिफ़ॉल्ट रेट लिमिट: प्रति कुंजी प्रति मिनट 60 अनुरोध, अलग नेटवर्क सीलिंग के साथ
- हस्ताक्षरित फ़ाइल URL जीवनकाल: 10 मिनट
- [OpenAPI 3.1 विवरण](https://embroideryfileconverter.com/developers/openapi.json)
- [API कुंजियाँ बनाएँ या रद्द करें](https://embroideryfileconverter.com/developers/keys)

API कुंजियाँ एक बार दिखाई जाती हैं, केवल SHA-256 हैश के रूप में स्टोर की जाती हैं, समाप्त होती हैं और तुरंत रद्द की जा सकती हैं। उपलब्ध क्षमताएँ `formats:read`, `usage:read`, `jobs:read`, और `jobs:write` हैं।

## क्विकस्टार्ट: कन्वर्ज़न जॉब बनाएँ

```bash
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 "file=@design.pes"
```

API HTTP 202 लौटाती है क्योंकि प्रोसेसिंग एसिंक्रोनस है:

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

`job.id` और `job.workflow` दोनों को स्थायी रखें। वर्कफ़्लो-विशिष्ट जॉब एंडपॉइंट को तब तक पोल करें जब तक स्टेटस `completed` या `failed` न हो जाए।

## जॉब निर्माण फ़ील्ड्स

### रूपांतरण

मौजूदा एम्ब्रॉयडरी मशीन फ़ाइल के लिए `workflow=conversion` का उपयोग करें।

- आवश्यक: `workflow`, `format`, और `file` या `files[]`
- अधिकतम सोर्स साइज़: प्रति फ़ाइल 50 MB
- आउटपुट `format` लिखने योग्य और डिटेक्टेड सोर्स फ़ॉर्मेट से भिन्न होना चाहिए।

### डिजिटाइज़िंग

JPG, JPEG, PNG, SVG, या WebP आर्टवर्क के लिए `workflow=digitising` का उपयोग करें।

- आवश्यक: `workflow`, `format`, `file` या `files[]`, `width_mm`, और `colour_count`
- `width_mm`: 10 से 300 तक की संख्या
- `colour_count`: 1 से 24 तक पूर्णांक
- अधिकतम सोर्स साइज़: प्रति फ़ाइल 20 MB

`files[]` एक बैच में अधिकतम 10 स्रोत स्वीकार करता है। सीमित निःशुल्क प्रसंस्करण वाले खातों को प्रति अनुरोध केवल एक स्रोत तक सीमित किया जा सकता है। बैच की प्रत्येक फ़ाइल एक ही वर्कफ़्लो और आउटपुट प्रारूप का उपयोग करती है।

## जॉब की स्थिति जांचें

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

संभावित स्थितियाँ `queued`, `processing`, `completed` और `failed` हैं। विस्तृत जॉब प्रतिक्रिया में मेट्रिक्स, चेतावनियाँ, विफलता जानकारी, इवेंट्स, पूर्वावलोकन आर्टिफैक्ट्स, आउटपुट्स, अनलॉक स्थिति और अस्थायी हस्ताक्षरित फ़ाइल URL शामिल होते हैं। हस्ताक्षरित URL समाप्त होने पर जॉब पुनः अनुरोध करें।

## पूर्ण एंडपॉइंट संदर्भ

- `GET /formats` के लिए `formats:read` आवश्यक है और यह `data[]` तथा `artworkInputs[]` लौटाता है।
- `GET /usage` के लिए `usage:read` आवश्यक है और यह भत्ते, क्रेडिट, वर्कफ़्लो लागत और रीसेट तिथियों सहित `freeUsage` लौटाता है।
- `GET /jobs` के लिए `jobs:read` आवश्यक है और यह अधिकतम 50 हाल के स्वामित्व वाले जॉब्स के लिए `data[]` तथा `freeUsage` लौटाता है।
- `POST /jobs` के लिए `jobs:write` आवश्यक है और यह एक या अधिक निजी अतुल्यकालिक पूर्वावलोकन जॉब्स बनाता है।
- `GET /jobs/conversion/{id}` के लिए `jobs:read` आवश्यक है और यह एक स्वामित्व वाला रूपांतरण जॉब लौटाता है।
- `GET /jobs/digitising/{id}` के लिए `jobs:read` आवश्यक है और यह एक स्वामित्व वाला डिजिटाइजिंग जॉब लौटाता है।
- `POST /jobs/conversion/{id}/retry` और `POST /jobs/digitising/{id}/retry` के लिए `jobs:write` आवश्यक है। केवल असफल जॉब्स जिनका स्रोत समाप्त नहीं हुआ है, उन्हें पुनः प्रयास किया जा सकता है।
- `POST /jobs/conversion/{id}/unlock` और `POST /jobs/digitising/{id}/unlock` के लिए `jobs:write` आवश्यक है। जॉब पूर्ण होना चाहिए।
- हस्ताक्षरित `GET /uploads/{id}/download` और `GET /uploads/{id}/preview` URL के लिए `jobs:read` आवश्यक है; इसे स्वयं बनाने के बजाय जॉब प्रतिक्रिया में लौटाए गए पूर्ण URL का उपयोग करें।

## अनलॉक व्यवहार

`job.unlock` या `GET /usage` अनलॉक करने से पहले जाँचें। अनलॉक अनुरोध उपलब्ध सदस्यता अधिकार या खाते में पहले से मौजूद प्रोसेसिंग क्रेडिट्स खर्च कर सकता है। आंतरिक खाते बिना शुल्क अनलॉक कर सकते हैं। यह चेकआउट खोलता नहीं है या क्रेडिट्स नहीं खरीदता। अपर्याप्त कोटा या क्रेडिट्स होने पर सत्यापन त्रुटि आती है।

## त्रुटियाँ और पुनःप्रयास व्यवहार

- `401`: डेवलपर कुंजी गुम, विकृत, समाप्त या निरस्त
- `403`: कुंजी क्षमता गुम या संसाधन दूसरे खाते का है
- `404`: जॉब या निजी फ़ाइल नहीं मिली
- `409`: वर्तमान जॉब स्थिति पुनःप्रयास या अनलॉक की अनुमति नहीं देती
- `410`: निजी स्रोत अपलोड समाप्त हो चुका है
- `422`: अमान्य फ़ील्ड, स्रोत फ़ाइल, आउटपुट प्रारूप, या अपर्याप्त कोटा
- `429`: दर सीमा पार हो गई; `Retry-After` का पालन करें और घातीय बैकऑफ़ के साथ जिटर का उपयोग करें

जॉब निर्माण भी अपलोड और प्रसंस्करण सीमाओं द्वारा सुरक्षित है, तथा अनलॉक मार्गों पर सख्त बिलिंग-एक्शन सीमा है। आक्रामक पोलिंग से बचें और टर्मिनल स्थिति के बाद रुकें।

## सुरक्षा मॉडल

ग्राहक फ़ाइलें निजी रहती हैं। प्रत्येक जॉब क्वेरी API-कुंजी स्वामी तक सीमित है, हस्ताक्षरित URL समाप्त होते हैं, डाउनलोड करने योग्य मशीन फ़ाइलें अधिकार जाँच पास होने तक लॉक रहती हैं, और अनुरोधित कार्रवाई निष्पादित होने से पहले कुंजी क्षमताएँ लागू की जाती हैं।

## संबंधित पृष्ठ

- [AI एजेंट और MCP](https://embroideryfileconverter.com/hi/ai-agents)
- [समर्थित कढ़ाई प्रारूप](https://embroideryfileconverter.com/hi/formats)
- [गोपनीयता और फ़ाइल प्रतिधारण](https://embroideryfileconverter.com/hi/privacy)