المفاهيم الأساسية لواجهة برمجة تطبيقات Fit-it-on للمطورين.

أساسيات واجهة برمجة التطبيقات

توفر واجهة برمجة تطبيقات Fit-it-on للمطورين وصولاً برمجيًا إلى نماذج توليد الذكاء الاصطناعي الخاصة بنا. وهي تتبع أنماط REST المعمارية القياسية، وتستخدم عناوين URL موجهة نحو الموارد يمكن التنبؤ بها، وتقبل نصوص طلبات مشفرة بصيغة JSON.

التنفيذ غير المتزامن

تتم معالجة جميع عمليات توليد الصور بشكل غير متزامن. تستغرق عمليات عرض الذكاء الاصطناعي عالية الدقة (عينات 2k أو 2048x2048) وقتًا، ومن شأن الاتصال المتزامن أن يؤدي حتمًا إلى انتهاء المهلة.

إرسال مهمة: ترسل طلب POST /v1/run مع بيانات الإدخال الخاصة بك.
استلام المعرف: تُرجع واجهة برمجة التطبيقات فورًا استجابة 200 OK مع prediction_id.
استقصاء الحالة: تقوم باستدعاء GET /v1/status/{predictionId} بشكل دوري.
الإكمال: عندما تنتقل الحالة إلى succeeded، ستكون عناوين URL لصورك التي تم إنشاؤها متاحة في مصفوفة output.

دعم الويب هوك بدلاً من ذلك، يمكنك توفير معلمة webhook_url في طلب POST الأولي الخاص بك. بمجرد انتهاء المهمة من المعالجة (سواء نجحت أو فشلت)، سنرسل طلب POST مباشرة إلى الويب هوك الخاص بك يحتوي على حمولة الحالة النهائية، مما يلغي الحاجة إلى الاستقصاء اليدوي.

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

يجب أن تتم جميع الطلبات عبر HTTPS إلى بيئة الإنتاج الخاصة بنا:

https://fititon.app/api

أنواع المحتوى

يجب أن تتضمن جميع طلبات POST و PATCH الرأس التالي لتحديد تنسيق الحمولة:

Content-Type: application/json

تُرجع واجهة برمجة التطبيقات أيضًا جميع الاستجابات بتنسيق JSON حصريًا.

الويب هوكس

إذا قمت بتوفير webhook_url في جذر حمولة JSON الخاصة بك، فسنرسل طلب HTTP POST إلى عنوان URL هذا بمجرد اكتمال المهمة غير المتزامنة (سواء بنجاح أو بوجود خطأ).

مثال على حمولة الويب هوك:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "success",
  "output": [
    "https://storage.fititon.com/results/result-123.jpg",
    "https://storage.fititon.com/results/result-124.jpg"
  ],
  "error": null,
  "created_at": "2026-07-03T10:00:00.000Z",
  "updated_at": "2026-07-03T10:00:15.000Z"
}

حدود الطلبات ومعالجتها

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

إذا تجاوزت حدك، ستتلقى خطأ 429 Too Many Requests. يجب أن يتعامل تطبيقك مع هذا بشكل رشيق من خلال تطبيق التراجع الأسي.

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

إذا فشلت عملية التوليد داخليًا (على سبيل المثال، تم تمرير صورة غير صالحة، أو حدث انتهاء مهلة للنموذج)، فستُرجع نقطة نهاية GET /v1/status حالة failed، وستحتوي خاصية error على رسالة وصفية. لن يتم خصم نقاطك مقابل المهام الفاشلة.