Ideal House
コンテンツにスキップ

認証情報と環境#

AI API リクエストには、利用中の Ideal House API アカウントに属する API キーを使用します。キーはサーバー側で保管し、APIKEY リクエストヘッダーで送信してください。

API キーの取得#

  1. AI API コンソールにサインインします。
  2. API キーの管理画面を開き、連携に使用するキーを生成または選択します。
  3. サーバーのシークレット管理機能または環境設定に保存します。ソース管理にコミットしたり、ブラウザー向けのバンドルに含めたりしないでください。

このドキュメントを読むだけでは、API キーは作成されず、アカウントへのアクセス権も付与されません。

リクエスト環境の設定#

選択した API リファレンスに記載されているベース URL とリクエストパスを使用します。例えば https://api.ideal.house が指定されている場合、ドキュメントの URL ではなく、その API ホストを使用します。

API キーは IDEALHOUSE_API_KEY など、サーバー専用の環境変数に保存します。この変数名はアプリケーション向けの例であり、SDK の設定項目ではありません。リクエストには次のヘッダーを含め、プレースホルダーをサーバー側で置き換えてください。

http
APIKEY: YOUR_API_KEY

エンドポイントで指定されたコンテンツタイプ、必須フィールド、画像入力形式に従ってください。非同期処理では、返されたタスク ID を保持し、その処理のドキュメントに記載された結果取得エンドポイントを使用します。

開発環境と本番環境#

キーを非公開に保つため、ローカルテストはバックエンド経由で実行します。公開前にデプロイ先のシークレットを設定し、料金、タスク制限、クレジットの消費を確認してください。テストリクエストでもアカウントのクレジットが消費される場合があります。このガイドは、別途無料のサンドボックスがあることを保証するものではありません。

マーチャント用の Shop ID、Publishable Key、商品インポート用の Client Secret は Visualizer SDK 連携で使用します。AI API キーの代わりにはなりません。マーチャントダッシュボードの Allowed Origins (CORS) 設定は Visualizer 連携用であり、サーバー側の AI API リクエストを設定するための手順ではありません。

認証の確認#

クイックスタートに従い、各処理のレスポンスを確認します。認証に失敗した場合は APIKEY ヘッダーを確認し、エラーコードを参照してください。ログやサポートに送るスクリーンショットからキーを削除します。