Ideal House
跳转到主要内容

凭据与环境#

AI API 请求使用属于您 Ideal House API 账户的 API 密钥。将其保留在服务器上,并在 APIKEY 请求头中发送。

获取 API 密钥#

  1. 登录 AI API 控制台
  2. 打开 API 密钥控件,生成或选择用于集成的密钥。
  3. 将其存储在服务器的密钥管理器或环境配置中。不要提交到源代码控制或包含在浏览器包中。

阅读这些文档不会创建 API 密钥或授予账户访问权限。

配置请求环境#

使用所选 API 参考 中规定的 Base URL 和请求路径。例如,指定 https://api.ideal.house 的参考使用该 API 主机,而不是文档 URL。

将 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 头并查阅 错误代码。从日志和支持屏幕截图中移除密钥。