وثائق المطورين

واجهة برمجة تطبيقات neofashion.ai

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

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

تُدار إصدارات جميع نقاط النهاية ضمن /api/v1 وتُقدَّم عبر HTTPS. يستخدم تطبيق الويب نقاط النهاية نفسها — ولا توجد مسارات خاصة بواجهة UI فقط.

Base URL

https://app.neofashion.ai/api/v1

المصادقة

تُصادَق كل طلباتك باستخدام رمز Bearer. يُدعَم نوعان من الرموز، وكلاهما يُحلّ إلى سياق workspace نفسه.

مفتاح API

لتكاملات الخادم إلى الخادم. أنشئ المفاتيح من إعدادات workspace؛ كل مفتاح مقيّد بـ workspace الخاص بك. متاح في خطط Enterprise.

Authorization: Bearer ne_live_xxxxxxxxxxxx

جلسة JWT

يُصدره تطبيق الويب عند تسجيل الدخول. يستخدمه واجهة المنصة نفسها ويلائم الاستدعاءات القصيرة ضمن نطاق المستخدم.

Authorization: Bearer eyJhbGci...

تتضمن جميع الطلبات الحقل source (ui أو api) وحقل api_key_id اختيارياً لأغراض التدقيق والفوترة.

نقاط النهاية

نقاط نهاية التوليد والقراءة الأساسية. تعمل المهام الطويلة مثل الفيديو والتوليد المجمع بشكل غير متزامن — استطلع التوليد أو تابع تحديثات الحالة في التطبيق.

الطريقة	نقطة النهاية	الوصف
POST	`/api/v1/generate/image`	إنشاء صورة منتج واحد
POST	`/api/v1/generate/video`	إنشاء فيديو أزياء قصير
POST	`/api/v1/generate/bulk`	مهمة إنشاء دفعة غير متزامنة
POST	`/api/v1/sketch-to-photo`	رسم ← صورة بجودة الحملة
GET	`/api/v1/generations`	قائمة الأجيال (مرقّمة الصفحات)
GET	`/api/v1/generations/:id`	تفاصيل الجيل + الحالة
GET	`/api/v1/credits/balance`	الرصيد الائتماني الحالي
GET	`/api/v1/personas`	شخصيات مساحة العمل
GET	`/api/v1/models`	واجهة برمجة تطبيقات (API) البصمة الوراثية للعلامة التجارية / الشخصيات

بنية الاستجابة

تعيد كل نقطة نهاية الغلاف نفسه: data وmeta ‏(credits المستخدمة، credits المتبقية، معرّف الطلب) وerror. يُضبط واحد فقط من data أو error.

نجاح

{
  "data": {
    "id": "gen_01hwz...",
    "status": "completed",
    "output_url": "https://...",
    "credits_used": 50
  },
  "meta": {
    "credits_used": 50,
    "credits_remaining": 7950,
    "request_id": "req_01hwz..."
  },
  "error": null
}

خطأ

{
  "data": null,
  "meta": { "request_id": "req_01hwz..." },
  "error": {
    "code": "INSUFFICIENT_CREDITS",
    "message": "Credit balance too low for this operation.",
    "details": { "required": 50, "available": 20 }
  }
}

حدود المعدل

تُطبّق الحدود لكل workspace. عند تجاوز الحد، تُرجع API القيمة 429 RATE_LIMITED مع رأس retry-after.

الخطة	حد المعدل
Enterprise	`مخصص - يتم الاتفاق عليه حسب العقد مع اتفاقية مستوى الخدمة (SLA).`

رموز الأخطاء

تُعاد الأخطاء في الحقل error مع code ثابت ورسالة مقروءة وتفاصيل منظمة.

الرمز	HTTP	المعنى
`INSUFFICIENT_CREDITS`	402	رصيد workspace منخفض جداً للعملية المطلوبة. أضف رصيداً أو رقِّ خطتك للمتابعة.
`UNAUTHORIZED`	401	الرمز مفقود أو منتهي الصلاحية أو غير صالح.
`FORBIDDEN`	403	الرمز صالح، لكن الخطة أو الدور لا يسمح بهذه العملية.
`NOT_FOUND`	404	المورد غير موجود أو ينتمي إلى workspace آخر.
`RATE_LIMITED`	429	طلبات كثيرة جداً — أعد المحاولة بعد المدة المحددة.
`PROVIDER_ERROR`	502	فشل مزود AI خارجي. ستُعاد credits ويمكن إعادة الطلب.

الوصول إلى API

هل أنت مستعد للتكامل؟

يتوفر الوصول إلى API في خطط Enterprise، مع تهيئة موجهة وSLA. احجز عرضاً توضيحياً لنستعرض تكاملك.

احجز عرضاً توضيحياً عرض الأسعار