تطريز محوّل الملفات
تسجيل الدخولإنشاء حساب مجانًا
مرجع واجهة برمجة التطبيقات · الإصدار 1JSON + متعدد الأجزاء

أضف التطريز إلى منتجك.

واجهة REST عملية لرقمنة الصور الخاصة وتحويل ملفات الآلة الحقيقية. هذه الصفحة هي دليل البداية السريعة الكامل ومرجع نقاط النهاية ودليل الأخطاء.

احصل على مفتاح واجهة برمجة التطبيقاتOpenAPI 3.1

عنوان URL الأساسي

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

المصادقة

مفتاح الحامل

المعدل

60/min

المهام

غير متزامن

المفاتيح محددة النطاق وتنتهي صلاحيتها ويمكن إبطالها فوراً وتُعرض مرة واحدة فقط. احتفظ بها على الخادم الخاص بك—لا ترسلها أبداً في كود المتصفح أو تطبيق الجوال.

نظرة عامةالبداية السريعةالمصادقةإنشاء مهمةدورة حياة المهمةمرجع نقاط النهايةالأخطاء والحدود
البداية السريعة

مهمتك الأولى في ثلاث خطوات.

01

أنشئ مفتاحاً

اختر فقط القدرات التي يحتاجها خدمتك واحفظ السر في مدير الأسرار على الخادم.

02

أرسل المصدر

أرسل بيانات نموذج متعدد الأجزاء عبر POST مع سير العمل وتنسيق الإخراج وملف مصدر خاص واحد.

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]"

المصادقة

مفاتيح الحامل محددة النطاق.

أرسل المفتاح في رأس التفويض مع كل طلب. يمكن للمفتاح الوصول فقط إلى مهام مالكه وفقط إلى القدرات المحددة عند إنشائه.

formats:read
usage:read
jobs:read
jobs:write
رأس التفويض
Authorization: Bearer efc_live_...
Accept: application/json

جانب الخادم فقط

لا تضمن مفتاح المطور في صفحة ويب أو ملف سطح مكتب موزع أو تطبيق جوال. وكّل الطلبات عبر الخلفية الخاصة بك.

هل تحتاج وصول مستخدم مفوض؟

يجب على عملاء الذكاء الاصطناعي استخدام MCP مع OAuth وPKCE بدلاً من تلقي مفتاح واجهة برمجة التطبيقات للمطور.

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 مقبول
{
  "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. قد يستهلك استدعاء نقطة نهاية الفتح رصيد اشتراك أو رصيد معالجة موجود. قد تفتح الحسابات الداخلية بدون مقابل. لا يفتح عملية شراء أو شراء رصيد.

مرجع نقاط النهاية

سطح الإصدار 1 الكامل.

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 طلبات في الدقيقة

يطبق الحد العام لكل مفتاح واجهة برمجة التطبيقات، مع سقف شبكة منفصل. تحتوي مسارات الرفع والمعالجة وفتح القفل على ضوابط إساءة استخدام أشد صرامة.

تعامل مع HTTP 429

احترم Retry-After واستخدم التراجع الأسي مع التباين. لا تستطلع المهام المكتملة أو الفاشلة باستمرار.

هل تبني لوكيل ذكاء اصطناعي؟

استخدم OAuth + MCP، وليس مفتاح واجهة برمجة التطبيقات.

يتضمن دليل الوكيل إعداد الاتصال وعناوين URL للاكتشاف وOAuth PKCE ومخطط كل أداة وأمثلة JSON-RPC جاهزة للنسخ.

افتح توثيق MCP

هل تحتاج مساعدة؟ اتصل بدعم المطورين

نزّل وصف OpenAPI