Ideal House
Aller au contenu principal

Documentation de configuration de style API#

URL de base : https://api.ideal.house
Version : v1
Mis à jour le : 2026-05-21


📖 Vue d'ensemble#

Le point de terminaison de configuration de style renvoie les groupes d'options de style utilisés par les API de génération. Ces options fournissent des identifiants valides pour des champs de requête tels que styleId, roomId, indoorStyleId, sceneId et d'autres paramètres de style similaires.

Les pages de fonctionnalités prises en charge incluent :

FonctionnalitétoolName
Visualisation de plansai_plan_visualizer
Remplacement de mobilierchange_furniture
Rénovation extérieureexterior_renovator
Décoration intérieurehome_decor_ideas
Réaménagement intérieurinteroir_remodel
Aménagement paysagerlandscaping
Mise en scène virtuellevirtual_staging

Les fichiers de ressources actuels incluent virtual-staging.json, de sorte que virtual_staging est le nom d'outil opérationnel pour la mise en scène virtuelle. La faute de frappe virual_staging n'est pas prise en charge par le fichier de ressources actuel et renvoie un contenu vide. Tout toolName non pris en charge renvoie un contenu vide.


🔐 Authentification#

En-têteValeur
APIKEYyour_api_key_here

📌 Point de terminaison API#

Obtenir la configuration de style#

Point de terminaison

Texte brut
GET /api/v1/style/{toolName}/getStyles

En-têtes de la requête

En-têteRequisDescription
APIKEY✅ OuiVotre clé d'authentification API

Paramètres de chemin

ParamètreTypeRequisDescription
toolNamestring✅ ObligatoireNom de la fonctionnalité, par exemple change_furniture ou ai_plan_visualizer

📥 Exemple de requête#

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

📤 Structure de réponse#

Le corps de la réponse est regroupé par catégorie de style. Chaque catégorie correspond à un paramètre de requête via 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"
        }
      ]
    }
  }
}
ChampTypeDescription
backendParamKeystringChamp du corps de la requête qui doit recevoir l'id de l'option sélectionnée
optionsarrayOptions de style disponibles
options[].nameobjectNom de style multilingue
options[].idstringIdentifiant de style à transmettre dans la requête API
options[].urlstringImage d'aperçu montrant le style

Certains champs de requête prennent en charge plusieurs identifiants d'option. Pour ces champs, joignez les valeurs id sélectionnées avec une virgule, par exemple id1,id2.


🧭 Correspondance des noms d'outils#

Visualisation de plans#

Texte brut
GET /api/v1/style/ai_plan_visualizer/getStyles
Groupe de styleChamp de requête
planTypeplanStyleId
stylestyleId
viewviewId

Remplacement de mobilier#

Texte brut
GET /api/v1/style/change_furniture/getStyles
Groupe de styleChamp de requête
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (prend en charge plusieurs identifiants séparés par des virgules)

Rénovation extérieure#

Texte brut
GET /api/v1/style/exterior_renovator/getStyles
Groupe de styleChamp de requête
buildingStylebuildingStyleId
environmentenvironmentId (prend en charge plusieurs identifiants séparés par des virgules)

Décoration intérieure#

Texte brut
GET /api/v1/style/home_decor_ideas/getStyles
Groupe de styleChamp de requête
spaceTypespaceStyleId
decorStylehomeDecorStyleId

Réaménagement intérieur#

Texte brut
GET /api/v1/style/interoir_remodel/getStyles
Groupe de styleChamp de requête
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (prend en charge plusieurs identifiants séparés par des virgules)

Aménagement paysager#

Texte brut
GET /api/v1/style/landscaping/getStyles
Groupe de styleChamp de requête
gardenStylesceneId
elementssceneElementId (prend en charge plusieurs identifiants séparés par des virgules)

Mise en scène virtuelle#

Texte brut
GET /api/v1/style/virtual_staging/getStyles
Groupe de styleChamp de requête
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (prend en charge plusieurs identifiants séparés par des virgules)

❌ Réponses d'erreur#

CodeNomDescription
5002API_KEY_INVALIDClé API invalide ou manquante

Pour les valeurs toolName non prises en charge, le point de terminaison renvoie un contenu vide dans data.