🆕

实时API

Spline 中的 APIs 功能允许你集成外部服务、检索或发送数据,并根据事件自动化响应。这将让你的 Spline 项目能够实现动态和互动的体验。

image

创建新的 API 项目

image
  • 导航到 Spline 编辑器右侧边栏的“变量和数据”面板(在编辑器中未选择任何内容时可访问)。
  • 点击“APIs”标签。
  • 点击“新建 API”创建一个新的 API 项目。
  • 重命名 API,将默认名称“新建 API ”更改为更具描述性的名称,以便更好地组织你的 API。

配置 API

选择你希望与 API 通信的方式,以下是可选项:

  • GET: 获取数据。
  • POST: 发送数据。
  • DELETE: 删除数据。
  • PUT: 更新数据。
  • HEAD: 仅获取Headers信息。
  • OPTIONS: 描述允许的方法。
  • PATCH: 应用部分修改。
image

API URL:

添加你的 API URL。

开始时请求:

选择在场景加载时是否应自动启动 API 请求(是或否)。

Headers:

通过输入“按键”和“值”添加必要的Headers信息。使用“+”图标添加多个Header信息。

image

响应处理

预览: 可以直接在“响应”标签中预览 API 响应。

刷新: 点击更新按钮以获取 API 的最新响应。

在 Spline 中使用 API 响应

API 更新事件

当 API 收到响应时触发此交互事件。

API 请求操作

你可以基于特定交互事件(如场景开始、鼠标点击或任何其他自定义事件)触发 API 请求。

使用变量与 APIs

在使用 APIs 时,获取到的数据可以存储在变量中,然后用于动态更新 Spline 项目中的属性。以下是如何利用变量的方式:

  • 从 API 响应设置变量: 你可以将响应数据映射到特定变量(例如,数字、字符串、布尔值)。例如,如果你的 API 返回一个温度值,你可以将此值存储在数字变量中。
  • 更新对象属性: 变量可以附加到对象属性,如位置、缩放或颜色。例如,如果你从 API 接收到一个新位置,你可以动态更新对象的位置。
  • 基于变量触发操作: 使用变量变化事件在 API 更新变量时触发操作。例如,如果 API 更新了一个字符串变量的新文本,你可以自动更新场景中的文本标签。

实际使用案例

💡
APIs 提供了将外部服务集成到 Spline 项目中的无限可能,帮助你创建高度定制化和动态的体验。根据你选择集成的服务,功能可能有很大差异。以下是一些示例:
  • 动态天气显示:
    • 使用天气 API 获取实时天气数据。
    • 将温度存储在数字变量中并显示在文本对象上。
    • 使用变量变化事件触发视觉变化,如根据天气条件更改背景颜色。
  • 实时记分板:
    • 集成体育 API 获取实时比分。
    • 使用变量实时更新比分并显示在记分板上。
    • 当收到新比分时触发动画。
  • 通用 API 集成:
    • 连接 Airtable 等服务以管理和显示场景中的动态数据。
    • 使用 OpenAI 动态生成文本,提供基于 AI 生成响应的实时更新。
    • 与任何其他 REST API 集成以获取或发送数据,使你的 Spline 项目几乎可以实现无限的可能性。

最佳实践

  • 测试: 彻底测试你的 API 配置,确保其按预期工作。
  • 优化: 仅在必要时使用“开始时请求”选项,以减少 API 调用的次数。
  • 警告: 切勿公开分享敏感信息,如 API 密钥或授权令牌。确保这些信息安全存储,并仅在受保护的环境中使用。

👉下一步

🆕Webhooks