Ideal House
ข้ามไปยังเนื้อหา

เอกสาร API#

URLพื้นฐาน: https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-05-21


📖 ภาพรวม#

ปลายทาง API คืนกลุ่มตัวเลือกสไตล์ที่ใช้โดย API สร้างภาพ ตัวเลือกเหล่านี้ให้ ID ที่ถูกต้องสำหรับฟิลด์คำขอ เช่น 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[].idstringID สไตล์ที่จะส่งในคำขอ API
options[].urlstringภาพตัวอย่างแสดงสไตล์

ฟิลด์คำขอบางตัวรองรับ ID ตัวเลือกหลายค่า สำหรับฟิลด์เหล่านั้น ให้รวมค่า id ที่เลือกด้วยเครื่องหมายจุลภาค เช่น id1,id2


🧭 การแมปชื่อเครื่องมือ#

แสดงภาพแปลน#

ข้อความธรรมดา
GET /api/v1/style/ai_plan_visualizer/getStyles
กลุ่มสไตล์ฟิลด์คำขอ
planTypeplanStyleId
stylestyleId
viewviewId

เปลี่ยนเฟอร์นิเจอร์#

ข้อความธรรมดา
GET /api/v1/style/change_furniture/getStyles
กลุ่มสไตล์ฟิลด์คำขอ
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (รองรับ ID หลายค่าที่คั่นด้วยเครื่องหมายจุลภาค)

ปรับปรุงภายนอก#

ข้อความธรรมดา
GET /api/v1/style/exterior_renovator/getStyles
กลุ่มสไตล์ฟิลด์คำขอ
buildingStylebuildingStyleId
environmentenvironmentId (รองรับ ID หลายค่าที่คั่นด้วยเครื่องหมายจุลภาค)

ตกแต่งบ้าน#

ข้อความธรรมดา
GET /api/v1/style/home_decor_ideas/getStyles
กลุ่มสไตล์ฟิลด์คำขอ
spaceTypespaceStyleId
decorStylehomeDecorStyleId

ปรับปรุงการตกแต่งภายใน#

ข้อความธรรมดา
GET /api/v1/style/interoir_remodel/getStyles
กลุ่มสไตล์ฟิลด์คำขอ
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (รองรับ ID หลายค่าที่คั่นด้วยเครื่องหมายจุลภาค)

ออกแบบภูมิทัศน์#

ข้อความธรรมดา
GET /api/v1/style/landscaping/getStyles
กลุ่มสไตล์ฟิลด์คำขอ
gardenStylesceneId
elementssceneElementId (รองรับ ID หลายค่าที่คั่นด้วยเครื่องหมายจุลภาค)

จัดเฟอร์นิเจอร์เสมือนจริง#

ข้อความธรรมดา
GET /api/v1/style/virtual_staging/getStyles
กลุ่มสไตล์ฟิลด์คำขอ
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (รองรับ ID หลายค่าที่คั่นด้วยเครื่องหมายจุลภาค)

❌ การตอบสนองข้อผิดพลาด#

รหัสชื่อคำอธิบาย
5002API_KEY_INVALIDคีย์ API ไม่ถูกต้องหรือไม่พบ

สำหรับค่า toolName ที่ไม่รองรับ เอนด์พอยต์จะคืนค่าว่างใน data