Ideal House
İçeriğe atla

Kimlik bilgileri ve ortamlar#

AI API istekleri, Ideal House API hesabınıza ait bir API anahtarı kullanır. Bunu sunucunuzda tutun ve APIKEY istek başlığı içinde gönderin.

Bir API anahtarı edinin#

  1. AI API Konsolu'na oturum açın.
  2. API anahtar denetimlerini açın ve entegrasyonunuz için anahtarı oluşturun veya seçin.
  3. Bunu sunucunuzun gizli bilgi yöneticisinde veya ortam yapılandırmasında saklayın. Kaynak kodu denetimine eklemeyin veya bir tarayıcı paketine dahil etmeyin.

Bu belgeleri okumak bir API anahtarı oluşturmaz veya bir hesaba erişim sağlamaz.

İstek ortamını yapılandırın#

Seçilen API referansında belirtilen Temel URL'i ve istek yolunu kullanın. Örneğin, https://api.ideal.house'yi belirten referanslar, belgelendirme URL'sı değil, o API ana bilgisayarını kullanır.

API anahtarını, IDEALHOUSE_API_KEY gibi yalnızca sunucu tarafı bir ortam değişkeninde tutun. Bu, uygulamanız için örnek bir değişken adıdır; bir SDK ayarı değildir. Bir istek, yer tutucunun sunucunuzda değiştirildiği aşağıdaki başlığı içermelidir:

http
APIKEY: YOUR_API_KEY

Uç noktanın gerekli içerik türünü, alanlarını ve görüntü girdi biçimini izleyin. Asenkron işlemler için, döndürülen görev kimliğini koruyun ve o işlem için belgelenmiş sonuç uç noktasını kullanın.

Geliştirme ve üretim#

Anahtarın gizli kalması için yerel testleri arka uç sunucunuz üzerinden çalıştırın. Yayınlamadan önce dağıtım gizli bilgilerini yapılandırın ve fiyatlandırmayı, görev sınırlarını ve kredi düşülmelerini kontrol edin. Test istekleri hesap kredilerini kullanabilir; bu kılavuzlar ayrı bir ücretsiz deneme ortamı (sandbox) vaat etmez.

Satıcı Shop ID, Publishable Key ve Ürün İçe Aktarma Client Secret, Visualizer SDK entegrasyonuna aittir. Bunlar bir AI API anahtarının yerini tutmaz. Satıcı Paneli'nin Allowed Origins (CORS) ayarı, sunucu tarafı AI API istekleri için kurulum adımı değil, Görselleştirici entegrasyonu içindir.

Kimlik doğrulamayı doğrulayın#

Hızlı Başlangıcı izleyin, ardından işlem özelindeki yanıtı kontrol edin. Kimlik doğrulama başarısız olursa, APIKEY başlığını doğrulayın ve hata kodlarına başvurun. Anahtarları kayıtlardan ve destek ekran görüntülerinden kaldırın.