Ideal House
Przejdź do treści

Dane uwierzytelniające i środowiska#

Żądania AI API używają klucza API należącego do Twojego konta Ideal House API. Przechowuj go na swoim serwerze i wysyłaj w nagłówku żądania APIKEY.

Uzyskanie klucza API#

  1. Zaloguj się do konsoli AI API.
  2. Otwórz elementy sterujące kluczem API i wygeneruj lub wybierz klucz dla swojej integracji.
  3. Przechowuj go w menedżerze sekretów serwera lub konfiguracji środowiska. Nie zapisuj go w systemie kontroli wersji ani nie dołączaj do pakietu kodu wysyłanego do przeglądarki.

Czytanie tych dokumentów nie tworzy klucza API ani nie udziela dostępu do konta.

Konfiguracja środowiska żądania#

Użyj bazowego adresu URL i ścieżki żądania podanych w wybranej dokumentacji API. Na przykład dokumenty wskazujące https://api.ideal.house odnoszą się do tego hosta API, a nie do adresu URL dokumentacji.

Przechowuj klucz API w zmiennej środowiskowej tylko po stronie serwera, takiej jak IDEALHOUSE_API_KEY. Jest to przykładowa nazwa zmiennej dla Twojej aplikacji; nie jest to ustawienie SDK. Żądanie powinno zawierać następujący nagłówek, z wartością zastępczą podmienioną na Twoim serwerze:

http
APIKEY: YOUR_API_KEY

Postępuj zgodnie z wymaganym typem treści, polami i formatem wejściowym obrazu punktu końcowego. Dla operacji asynchronicznych zachowaj zwrócony identyfikator zadania i użyj punktu końcowego wyników udokumentowanego dla tej operacji.

Rozwój i produkcja#

Wykonuj testy lokalne przez swój backend, aby klucz pozostał prywatny. Skonfiguruj sekrety wdrożenia przed publikacją i sprawdź cennik, limity zadań i pobieranie kredytów. Żądania testowe mogą używać kredytów konta; te przewodniki nie obiecują oddzielnego, bezpłatnego środowiska testowego.

Shop ID, Publishable Key oraz Client Secret do importu produktów należą do integracji Visualizer SDK sprzedawcy. Nie zastępują klucza AI API. Ustawienie Allowed Origins (CORS) w panelu sprzedawcy dotyczy integracji wizualizatora, a nie konfiguracji żądań AI API wysyłanych z serwera.

Weryfikacja uwierzytelniania#

Postępuj zgodnie z Szybkim startem, a następnie sprawdź odpowiedź specyficzną dla operacji. Jeśli uwierzytelnianie nie powiedzie się, zweryfikuj nagłówek APIKEY i skonsultuj kody błędów. Usuń klucze z logów i zrzutów ekranów pomocy technicznej.