רקמה ממיר קבצים
התחברותהירשם בחינם
הפניה ל-API · v1JSON + multipart

שלב רקמה ב- המוצר שלך.

REST API מעשי לדיגיטציה פרטית של תמונות ולהמרת קובצי מכונה אמיתיים. עמוד זה מכיל את המדריך המלא להתחלה מהירה, הפניות לנקודות קצה ומדריך שגיאות.

קבל מפתח APIOpenAPI 3.1

כתובת בסיס

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

אימות

מפתח Bearer

קצב

60/min

עבודות

אסינכרוני

המפתחות מוגבלים בהיקף, פוקעים, ניתנים לביטול מיידי ומוצגים פעם אחת בלבד. שמור אותם בשרת שלך—לעולם אל תשלח מפתח בקוד דפדפן או לקוח נייד.

סקירההתחלה מהירהאימותצור עבודהמחזור חיי עבודההפניית נקודות קצהשגיאות ומגבלות
התחלה מהירה

העבודה הראשונה שלך בשלושה שלבים.

01

צור מפתח

בחר רק את היכולות שהשירות שלך צריך ואחסן את הסוד במנהל סודות בצד השרת.

02

שלח את המקור

שלח נתוני טופס multipart עם זרימת העבודה, תבנית הפלט וקובץ מקור פרטי אחד.

03

סקור את העבודה

השתמש בזרימת העבודה ובמזהה העבודה שהוחזרו עד שהסטטוס יהיה הושלם או נכשל.

צור עבודת המרה · 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

צד שרת בלבד

אל תטמיע מפתח מפתח בדף אינטרנט, קובץ בינארי של שולחן עבודה או אפליקציה ניידת. העבר בקשות דרך הקצה העורפי שלך.

צריך גישת משתמש מואצלת?

לקוחות 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 מ"מ · 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"

מדדים

ספירת תפרים, מידות ומדידות ספציפיות למנוע.

אזהרות

הערות תאימות או ייצור שהממשק שלך צריך להציג.

קבצים פרטיים

כתובות URL חתומות תקפות ל-10 דקות ועדיין אוכפות בעלות ומצב נעילה.

שחרור נעילה עשוי לצרוך זכאות

בדוק תחילה job.unlock או GET /usage. קריאה לנקודת הקצה של השחרור עשויה לצרוך הקצאת מנוי או קרדיטים קיימים לעיבוד. חשבונות פנימיים עשויים לשחרר ללא תשלום. פעולה זו אינה פותחת רכישה או קניית קרדיטים.

הפניית נקודות קצה

ממשק 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 והשתמש ב-backoff מעריכי עם jitter. אל תסקור עבודות שהושלמו או נכשלו באופן רציף.

בונה לסוכן AI?

השתמש ב-OAuth + MCP, לא במפתח API.

מדריך הסוכן כולל הגדרת חיבור, כתובות URL לגילוי, OAuth PKCE, כל סכימת כלי ודוגמאות JSON-RPC מוכנות להעתקה.

פתח תיעוד MCP

צריך עזרה? צור קשר עם תמיכת מפתחים

הורד את תיאור OpenAPI