Ideal House
İçeriğe atla

API Stil Yapılandırması Belgelendirmesi#

Temel URL: https://api.ideal.house
Sürüm: v1
Güncellendi: 2026-05-21


📖 Genel Bakış#

API Stil Yapılandırması uç noktası, üretim API'leri tarafından kullanılan stil seçenek gruplarını döndürür. Bu seçenekler, styleId, roomId, indoorStyleId, sceneId ve benzeri stil parametreleri gibi istek alanları için geçerli kimlik numaraları sağlar.

Desteklenen özellik sayfaları şunları içerir:

ÖzelliktoolName
Plan Görselleştiriciai_plan_visualizer
Mobilya Değiştirmechange_furniture
Dış Cephe Yenilemeexterior_renovator
Ev Dekorasyonuhome_decor_ideas
İç Mekan Yenilemeinteroir_remodel
Peyzaj Tasarımılandscaping
Sanal Sahnelemevirtual_staging

Mevcut kaynak dosyaları virtual-staging.json içerdiğinden, Sanal Sahneleme için çalışan araç adı virtual_staging'dur. Yanlış yazılmış virual_staging, mevcut kaynak dosyasıyla desteklenmemektedir ve boş içerik döndürür. Desteklenmeyen herhangi bir toolName boş içerik döndürür.


🔐 Kimlik Doğrulama#

BaşlıkDeğer
APIKEYyour_api_key_here

📌 API Uç Nokta#

Stil Yapılandırmasını Getirme#

Uç nokta

Düz metin
GET /api/v1/style/{toolName}/getStyles

İstek Başlıkları

BaşlıkZorunluAçıklama
APIKEY✅ EvetAPI kimlik doğrulama anahtarınız

Yol Parametreleri

ParametreTürZorunluAçıklama
toolNamestring✅ EvetÖzellik adı, örneğin change_furniture veya ai_plan_visualizer

📥 İstek Örneği#

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

📤 Yanıt Yapısı#

Yanıt gövdesi stil kategorisine göre gruplandırılır. Her kategori, backendParamKey üzerinden bir istek parametresine eşlenir.

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"
        }
      ]
    }
  }
}
AlanTürAçıklama
backendParamKeystringSeçilen seçeneğin id değerini alması gereken istek gövdesi alanı
optionsarrayKullanılabilir stil seçenekleri
options[].nameobjectÇok dilli stil adı
options[].idstringAPI isteğine geçirilecek stil kimlik numarası
options[].urlstringStili gösteren önizleme görüntüsü

Bazı istek alanları birden fazla seçenek kimlik numarasını destekler. Bu alanlar için seçilen id değerlerini virgülle birleştirin, örneğin id1,id2.


🧭 Araç Adı Eşlemesi#

Plan Görselleştirici#

Düz metin
GET /api/v1/style/ai_plan_visualizer/getStyles
Stil Grubuİstek Alanı
planTypeplanStyleId
stylestyleId
viewviewId

Mobilya Değiştirme#

Düz metin
GET /api/v1/style/change_furniture/getStyles
Stil Grubuİstek Alanı
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (virgülle ayrılmış birden fazla kimlik numarasını destekler)

Dış Cephe Yenileme#

Düz metin
GET /api/v1/style/exterior_renovator/getStyles
Stil Grubuİstek Alanı
buildingStylebuildingStyleId
environmentenvironmentId (virgülle ayrılmış birden fazla kimlik numarasını destekler)

Ev Dekorasyonu#

Düz metin
GET /api/v1/style/home_decor_ideas/getStyles
Stil Grubuİstek Alanı
spaceTypespaceStyleId
decorStylehomeDecorStyleId

İç Mekan Yenileme#

Düz metin
GET /api/v1/style/interoir_remodel/getStyles
Stil Grubuİstek Alanı
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (virgülle ayrılmış birden fazla kimlik numarasını destekler)

Peyzaj Tasarımı#

Düz metin
GET /api/v1/style/landscaping/getStyles
Stil Grubuİstek Alanı
gardenStylesceneId
elementssceneElementId (virgülle ayrılmış birden fazla kimlik numarasını destekler)

Sanal Sahneleme#

Düz metin
GET /api/v1/style/virtual_staging/getStyles
Stil Grubuİstek Alanı
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (virgülle ayrılmış birden fazla kimlik numarasını destekler)

❌ Hata Yanıtları#

KodAdAçıklama
5002API_KEY_INVALIDGeçersiz veya eksik API anahtarı

Desteklenmeyen toolName değerleri için uç nokta, data içinde boş içerik döndürür.