Ideal House
Passa al contenuto

Documentazione della configurazione degli stili API#

URL di base: https://api.ideal.house
Versione: v1
Aggiornato: 2026-05-21


📖 Panoramica#

L'endpoint di configurazione degli stili API restituisce gruppi di opzioni di stile usati dalle APIs di generazione. Queste opzioni forniscono identificatori validi per campi della richiesta come styleId, roomId, indoorStyleId, sceneId e parametri di stile simili.

Le pagine delle funzionalità supportate comprendono:

FunzionalitàtoolName
Visualizzazione delle planimetrieai_plan_visualizer
Sostituzione dei mobilichange_furniture
Ristrutturazione degli esterniexterior_renovator
Decorazione della casahome_decor_ideas
Ristrutturazione degli interniinteroir_remodel
Progettazione del paesaggiolandscaping
Allestimento virtualevirtual_staging

I file di risorse attuali includono virtual-staging.json, quindi virtual_staging è il nome funzionante dello strumento di allestimento virtuale. La grafia errata virual_staging non corrisponde al file di risorse attuale e restituisce contenuto vuoto. Qualsiasi toolName non supportato restituisce contenuto vuoto.


🔐 Autenticazione#

IntestazioneValore
APIKEYyour_api_key_here

📌 Endpoint API#

Ottieni la configurazione degli stili#

Endpoint

Testo semplice
GET /api/v1/style/{toolName}/getStyles

Intestazioni della richiesta

IntestazioneObbligatoriaDescrizione
APIKEY✅ SìLa tua chiave di autenticazione API

Parametri del percorso

ParametroTipoObbligatorioDescrizione
toolNamestring✅ SìNome della funzionalità, ad esempio change_furniture o ai_plan_visualizer

📥 Esempio di richiesta#

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

📤 Struttura della risposta#

Il corpo della risposta è raggruppato per categoria di stile. Ogni categoria viene associata a un parametro della richiesta tramite 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"
        }
      ]
    }
  }
}
CampoTipoDescrizione
backendParamKeystringCampo del corpo della richiesta che deve ricevere l'id dell'opzione selezionata
optionsarrayOpzioni di stile disponibili
options[].nameobjectNome multilingue dello stile
options[].idstringIdentificatore dello stile da passare nella richiesta API
options[].urlstringImmagine di anteprima dello stile

Alcuni campi della richiesta supportano più identificatori di opzione. Per questi campi, unisci i valori id selezionati con una virgola, ad esempio id1,id2.


🧭 Associazione dei nomi degli strumenti#

Visualizzazione delle planimetrie#

Testo semplice
GET /api/v1/style/ai_plan_visualizer/getStyles
Gruppo di stileCampo della richiesta
planTypeplanStyleId
stylestyleId
viewviewId

Sostituzione dei mobili#

Testo semplice
GET /api/v1/style/change_furniture/getStyles
Gruppo di stileCampo della richiesta
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (supporta più identificatori separati da virgole)

Ristrutturazione degli esterni#

Testo semplice
GET /api/v1/style/exterior_renovator/getStyles
Gruppo di stileCampo della richiesta
buildingStylebuildingStyleId
environmentenvironmentId (supporta più identificatori separati da virgole)

Decorazione della casa#

Testo semplice
GET /api/v1/style/home_decor_ideas/getStyles
Gruppo di stileCampo della richiesta
spaceTypespaceStyleId
decorStylehomeDecorStyleId

Ristrutturazione degli interni#

Testo semplice
GET /api/v1/style/interoir_remodel/getStyles
Gruppo di stileCampo della richiesta
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (supporta più identificatori separati da virgole)

Progettazione del paesaggio#

Testo semplice
GET /api/v1/style/landscaping/getStyles
Gruppo di stileCampo della richiesta
gardenStylesceneId
elementssceneElementId (supporta più identificatori separati da virgole)

Allestimento virtuale#

Testo semplice
GET /api/v1/style/virtual_staging/getStyles
Gruppo di stileCampo della richiesta
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (supporta più identificatori separati da virgole)

❌ Risposte di errore#

CodiceNomeDescrizione
5002API_KEY_INVALIDChiave API non valida o mancante

Per valori toolName non supportati, l'endpoint restituisce contenuto vuoto in data.