Ideal House
تخطّي إلى المحتوى

توثيق API لإعداد الأنماط#

URL الأساسي: https://api.ideal.house
الإصدار: v1
آخر تحديث: 2026-05-21


📖 نظرة عامة#

تُرجع نقطة نهاية API لإعداد الأنماط مجموعات خيارات الأنماط المستخدمة في APIs الخاصة بالتوليد. توفر هذه الخيارات معرّفات صالحة لحقول الطلب مثل styleId وroomId وindoorStyleId وsceneId ومعلمات الأنماط المشابهة.

تشمل صفحات الميزات المدعومة ما يلي:

الميزةtoolName
معاينة الخططai_plan_visualizer
تغيير الأثاثchange_furniture
تجديد الواجهات الخارجيةexterior_renovator
أفكار الديكور المنزليhome_decor_ideas
تجديد داخليinteroir_remodel
تنسيق الحدائقlandscaping
التأثيث الافتراضيvirtual_staging

تتضمن ملفات الموارد الحالية virtual-staging.json، لذا فإن virtual_staging هو اسم الأداة العامل لـ التأثيث الافتراضي. اسم virual_staging الذي يحتوي على خطأ إملائي غير مدعوم بواسطة ملفات الموارد الحالية ويعيد محتوى فارغًا. أي toolName غير مدعوم يعيد محتوى فارغًا.


🔐 المصادقة#

الرأسالقيمة
APIKEYyour_api_key_here

📌 API نقطة النهاية#

الحصول على تكوين الأسلوب#

نقطة النهاية

نص عادي
GET /api/v1/style/{toolName}/getStyles

رؤوس الطلب

الرأسمطلوبالوصف
APIKEY✅ نعممفتاح مصادقة API الخاص بك

معاملات المسار

المعاملالنوعمطلوبالوصف
toolNamestring✅ نعماسم الميزة، على سبيل المثال change_furniture أو ai_plan_visualizer

📥 مثال الطلب#

bash
curl -X GET "https://api.ideal.house/api/v1/style/change_furniture/getStyles" \
  -H "APIKEY: your_api_key_here"

📤 هيكل الاستجابة#

يتم تجميع جسم الاستجابة حسب فئة التصميم. يرتبط كل فئة بمعامل طلب من خلال backendParamKey.

json
{
  "code": 0,
  "message": "success",
  "data": {
    "roomType": {
      "backendParamKey": "indoorTypeId",
      "options": [
        {
          "name": {
            "en": "Living Room",
            "zh-CN": "客厅"
          },
          "id": "Interior Design_Interior Scene_Living Room",
          "url": "https://example.com/style-preview.webp"
        }
      ]
    }
  }
}
الحقلالنوعالوصف
backendParamKeystringحقل جسم الطلب الذي يجب أن يتلقى الـ id المحدد من الخيار
optionsarrayخيارات الأسلوب المتاحة
options[].nameobjectاسم الأسلوب متعدد اللغات
options[].idstringمعرف الأسلوب لتمريره في طلب API
options[].urlstringصورة معاينة تُظهر الأسلوب

بعض حقول الطلب تدعم معرفات خيارات متعددة. لتلك الحقول، اجمع قيم id المحددة بفاصلة، على سبيل المثال id1,id2.


🧭 خريطة أسماء الأدوات#

معاينة الخطط#

نص عادي
GET /api/v1/style/ai_plan_visualizer/getStyles
مجموعة الأسلوبحقل الطلب
planTypeplanStyleId
stylestyleId
viewviewId

تغيير الأثاث#

نص عادي
GET /api/v1/style/change_furniture/getStyles
مجموعة الأسلوبحقل الطلب
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (يدعم معرفات متعددة مفصولة بفاصلة)

تجديد الواجهات الخارجية#

نص عادي
GET /api/v1/style/exterior_renovator/getStyles
مجموعة الأسلوبحقل الطلب
buildingStylebuildingStyleId
environmentenvironmentId (يدعم معرفات متعددة مفصولة بفاصلة)

أفكار الديكور المنزلي#

نص عادي
GET /api/v1/style/home_decor_ideas/getStyles
مجموعة الأسلوبحقل الطلب
spaceTypespaceStyleId
decorStylehomeDecorStyleId

تجديد داخلي#

نص عادي
GET /api/v1/style/interoir_remodel/getStyles
مجموعة الأسلوبحقل الطلب
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (يدعم معرفات متعددة مفصولة بفاصلة)

تنسيق الحدائق#

نص عادي
GET /api/v1/style/landscaping/getStyles
مجموعة الأسلوبحقل الطلب
gardenStylesceneId
elementssceneElementId (يدعم معرفات متعددة مفصولة بفاصلة)

التأثيث الافتراضي#

نص عادي
GET /api/v1/style/virtual_staging/getStyles
مجموعة الأسلوبحقل الطلب
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (يدعم معرفات متعددة مفصولة بفاصلة)

❌ استجابات الخطأ#

الرمزالاسمالوصف
5002API_KEY_INVALIDمفتاح API غير صالح أو مفقود

بالنسبة لقيم toolName غير المدعومة، يعيد نقطة النهاية محتوى فارغًا في data.