API
API 模块使您能够通过 HTTP 请求使用 API 端点将工作流连接到外部服务。它支持多种方法，例如 GET、POST、PUT、DELETE 和 PATCH，几乎可以与任何 API 端点交互。
概述
API 模块使您能够：
连接外部服务：向 REST API 和 Web 服务发出 HTTP 请求
发送和接收数据：处理响应并转换来自外部来源的数据
集成第三方平台：连接 Stripe、Slack 或自定义 API 等服务
处理身份验证：支持包括 Bearer 令牌和 API 密钥在内的多种身份验证方法
工作原理
API 模块通过结构化的方法处理 HTTP 请求：
- 配置请求 - 设置 URL、方法、头信息和正文参数
- 执行请求 - 向指定端点发送 HTTP 请求
- 处理响应 - 处理响应数据、状态码和头信息
- 错误处理 - 管理超时、重试和错误情况
配置选项
URL
API 请求的端点 URL。可以是：
- 直接在模块中输入的静态 URL
- 从其他模块的输出连接的动态 URL
- 带有路径参数的 URL
方法
为您的请求选择 HTTP 方法：
- GET：从服务器检索数据
- POST：向服务器发送数据以创建资源
- PUT：更新服务器上的现有资源
- DELETE：从服务器删除资源
- PATCH：部分更新服务器上的现有资源
查询参数
定义将作为查询参数附加到 URL 的键值对。例如：
Key: apiKey
Value: your_api_key_here
Key: limit
Value: 10这些将被添加到 URL 中，如 ?apiKey=your_api_key_here&limit=10 所示。
请求头
为您的请求配置 HTTP 请求头。常见的请求头包括：
Key: Content-Type
Value: application/json
Key: Authorization
Value: Bearer your_token_here请求体
对于支持请求体的请求方法（POST、PUT、PATCH），您可以定义要发送的数据。请求体可以是：
- 直接在模块中输入的 JSON 数据
- 从其他模块的输出连接的数据
- 在工作流执行期间动态生成的数据
访问结果
在 API 请求完成后，您可以访问其输出：
<api.data>：来自 API 的响应体数据<api.status>：HTTP 状态码（200、404、500 等）<api.headers>：服务器返回的响应头<api.error>：如果请求失败，包含错误详情
高级功能
动态 URL 构建
使用来自前置模块的变量动态构建 URL：
// In a Function block before the API
const userId = <start.userId>;
const apiUrl = `https://api.example.com/users/${userId}/profile`;请求重试
API 模块会自动处理：
- 带有指数退避的网络超时
- 速率限制响应（429 状态码）
- 服务器错误（5xx 状态码）及重试逻辑
- 连接失败后的重新连接尝试
响应验证
在处理之前验证 API 响应：
// In a Function block after the API
if (<api.status> === 200) {
const data = <api.data>;
// Process successful response
} else {
// Handle error response
console.error(`API Error: ${<api.status>}`);
}输入和输出
URL：要发送请求的端点
方法：HTTP 方法（GET、POST、PUT、DELETE、PATCH）
查询参数：URL 参数的键值对
请求头：用于身份验证和内容类型的 HTTP 请求头
请求体：POST/PUT/PATCH 方法的请求负载
api.data：API 调用的响应体数据
api.status：服务器返回的 HTTP 状态码
api.headers：服务器返回的响应头
api.error：如果请求失败，包含错误详情
响应数据：主要的 API 响应内容
状态信息：HTTP 状态和错误详情
访问：在 API 调用后可用的模块
示例用例
获取用户档案数据
场景：从外部服务检索用户信息
- 函数模块根据输入构建用户 ID
- API 模块调用 GET /users/{id} 端点
- 函数模块处理并格式化用户数据
- 响应模块返回格式化的档案
支付处理
场景：通过 Stripe API 处理支付
- 函数模块验证支付数据
- API 模块通过 Stripe 创建支付意图
- 条件模块处理支付成功/失败
- Supabase 模块更新数据库中的订单状态
最佳实践
- 使用环境变量存储敏感数据：不要硬编码 API 密钥或凭据
- 优雅地处理错误：为失败的请求连接错误处理逻辑
- 验证响应：在处理数据之前检查状态码和响应格式
- 遵守速率限制：注意 API 的速率限制并实施适当的节流