Ideal House
Przejdź do treści

Dokumentacja konfiguracji stylu API#

Podstawowy URL: https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-05-21


📖 Przegląd#

Punkt końcowy konfiguracji stylu API zwraca grupy opcji stylu używane przez interfejsy generowania. Te opcje zapewniają poprawne identyfikatory dla pól żądania, takich jak styleId, roomId, indoorStyleId, sceneId oraz podobne parametry stylu.

Obsługiwane strony funkcji obejmują:

FunkcjatoolName
Wizualizator planuai_plan_visualizer
Zmiana meblichange_furniture
Renowacja elewacjiexterior_renovator
Dekoracja domuhome_decor_ideas
Remont wnętrzainteroir_remodel
Zagospodarowanie terenulandscaping
Wirtualne wystawianievirtual_staging

Bieżące pliki zasobów obejmują virtual-staging.json, dlatego virtual_staging jest prawidłową nazwą narzędzia do wirtualnego umeblowania. Błędna nazwa virual_staging nie ma odpowiadającego pliku zasobów i zwraca pustą zawartość. Każda nieobsługiwana wartość toolName zwraca pustą zawartość.


🔐 Uwierzytelnianie#

NagłówekWartość
APIKEYyour_api_key_here

📌 Punkt końcowy API#

Pobierz konfigurację stylu#

Punkt końcowy

Zwykły tekst
GET /api/v1/style/{toolName}/getStyles

Nagłówki żądania

NagłówekWymaganyOpis
APIKEY✅ TakTwój klucz uwierzytelniający API

Parametry ścieżki

ParametrTypWymaganyOpis
toolNamestring✅ TakNazwa funkcji, na przykład change_furniture lub ai_plan_visualizer

📥 Przykład żądania#

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

📤 Struktura odpowiedzi#

Ciało odpowiedzi jest grupowane według kategorii stylu. Każda kategoria jest mapowana do parametru żądania za pomocą pola 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"
        }
      ]
    }
  }
}
PoleTypOpis
backendParamKeystringPole w ciele żądania, które powinno otrzymać wybrany identyfikator opcji id
optionsarrayDostępne opcje stylu
options[].nameobjectWielojęzyczna nazwa stylu
options[].idstringIdentyfikator stylu do przesłania w żądaniu API
options[].urlstringObraz podglądu pokazujący styl

Niektóre pola żądania obsługują wiele identyfikatorów opcji. Dla tych pól połącz wybrane wartości id przecinkiem, na przykład id1,id2.


🧭 Mapowanie nazw narzędzi#

Wizualizator planu#

Zwykły tekst
GET /api/v1/style/ai_plan_visualizer/getStyles
Grupa stylówPole żądania
planTypeplanStyleId
stylestyleId
viewviewId

Zmiana mebli#

Zwykły tekst
GET /api/v1/style/change_furniture/getStyles
Grupa stylówPole żądania
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (obsługuje wiele identyfikatorów rozdzielonych przecinkiem)

Renowacja elewacji#

Zwykły tekst
GET /api/v1/style/exterior_renovator/getStyles
Grupa stylówPole żądania
buildingStylebuildingStyleId
environmentenvironmentId (obsługuje wiele identyfikatorów rozdzielonych przecinkiem)

Dekoracja domu#

Zwykły tekst
GET /api/v1/style/home_decor_ideas/getStyles
Grupa stylówPole żądania
spaceTypespaceStyleId
decorStylehomeDecorStyleId

Remont wnętrza#

Zwykły tekst
GET /api/v1/style/interoir_remodel/getStyles
Grupa stylówPole żądania
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (obsługuje wiele identyfikatorów rozdzielonych przecinkiem)

Zagospodarowanie terenu#

Zwykły tekst
GET /api/v1/style/landscaping/getStyles
Grupa stylówPole żądania
gardenStylesceneId
elementssceneElementId (obsługuje wiele identyfikatorów rozdzielonych przecinkiem)

Wirtualne wystawianie#

Zwykły tekst
GET /api/v1/style/virtual_staging/getStyles
Grupa stylówPole żądania
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (obsługuje wiele identyfikatorów rozdzielonych przecinkiem)

❌ Odpowiedzi błędów#

KodNazwaOpis
5002API_KEY_INVALIDNieprawidłowy lub brakujący klucz API

Dla nieobsługiwanych wartości toolName, punkt końcowy zwraca pustą zawartość w polu data.