Ideal House
Zum Hauptinhalt springen

Zugangsdaten und Umgebungen#

AI API-Anfragen verwenden einen API-Schlüssel, der zu Ihrem Ideal House API-Konto gehört. Halten Sie ihn auf Ihrem Server und senden Sie ihn im APIKEY-Anfrageheader.

Erhalten Sie einen API-Schlüssel#

  1. Melden Sie sich in der AI API-Konsole an.
  2. Öffnen Sie die API-Schlüsselsteuerungen und generieren oder wählen Sie den Schlüssel für Ihre Integration aus.
  3. Speichern Sie ihn im Secret-Manager oder in der Umgebungskonfiguration Ihres Servers. Nehmen Sie ihn weder in die Versionsverwaltung noch in ein Browser-Bundle auf.

Das Lesen dieser Dokumente erstellt keinen API-Schlüssel und gewährt keinen Zugang zu einem Konto.

Konfigurieren Sie die Anfrageumgebung#

Verwenden Sie die Basis-URL und den Anfragepfad aus der gewählten API-Referenz. Referenzen, die beispielsweise https://api.ideal.house angeben, verwenden diesen API-Host und nicht die Dokumentations-URL.

Halten Sie den API-Schlüssel in einer nur für den Server verfügbaren Umgebungsvariablen wie IDEALHOUSE_API_KEY. Dies ist ein Beispiel für einen Variablennamen für Ihre Anwendung; es ist keine SDK-Einstellung. Eine Anfrage sollte den folgenden Header enthalten, wobei der Platzhalter auf Ihrem Server ersetzt wird:

http
APIKEY: YOUR_API_KEY

Folgen Sie dem erforderlichen Content-Type, den Feldern und dem Bild-Eingabeformat des Endpunkts. Bewahren Sie für asynchrone Operationen die zurückgegebene Task-ID auf und verwenden Sie den für diese Operation dokumentierten Ergebnis-Endpunkt.

Entwicklung und Produktion#

Führen Sie lokale Tests über Ihr Backend aus, damit der Schlüssel privat bleibt. Konfigurieren Sie vor der Veröffentlichung die geheimen Zugangsdaten Ihrer Bereitstellung und prüfen Sie Preise, Aufgabenlimits und Guthabenabzüge. Testanfragen können Kontoguthaben verbrauchen; diese Anleitungen versprechen keine separate kostenlose Sandbox.

Händler-Shop ID, Publishable Key und Produkt-Import-Client Secret gehören zur Visualizer SDK-Integration. Sie ersetzen keinen AI API-Schlüssel. Die Einstellung Allowed Origins (CORS) im Händler-Dashboard ist für die Visualizer-Integration, nicht für den Einrichtungsschritt für serverseitige AI API-Anfragen.

Authentifizierung überprüfen#

Folgen Sie dem Schnellstart und prüfen Sie dann die operationsspezifische Antwort. Wenn die Authentifizierung fehlschlägt, überprüfen Sie den APIKEY-Header und konsultieren Sie die Fehlercodes. Entfernen Sie Schlüssel aus Protokollen und Support-Screenshots.