API 密钥与范围
API 密钥让脚本或其他系统无需登录控制台即可调用 xEvolve API。每个密钥带有限制其权限的范围。
创建密钥
- 打开 API 密钥并选择新建密钥。
- 输入名称,勾选所需范围,并可选择设置以天为单位的有效期。
- 复制密钥。它以
xev_开头,只显示一次。xEvolve 只保存哈希。
将密钥作为 bearer 令牌发送到您的工作区:
curl https://<workspace>.xevolve.io/api/v1/connections \
-H "Authorization: Bearer xev_<key>"吊销密钥立即生效。密钥的创建和吊销都会写入审计日志。
规则
- 密钥只能创建范围包含在自身范围内的密钥。请求更多范围会返回 403。
- 缺少所需范围的调用会返回 403 和
API key missing required scope。 - 控制台会话不受范围限制;它遵循用户的角色。
- 多重身份验证设置、会话管理、登录事件、服务主体注册、头像、保留策略和试用状态只接受控制台会话。API 密钥会收到 403。
范围
| 范围 | 允许 |
|---|---|
files:read | 列出、搜索和下载文件。 |
files:write | 上传文件。 |
transfers:read | 列出和查看传输。 |
transfers:write | 创建、运行和取消传输。 |
connections:read | 列出和查看连接。 |
connections:write | 创建、编辑、删除和测试连接。 |
data-rooms:read | 列出和查看数据室。 |
data-rooms:write | 创建、编辑和管理数据室。 |
schedules:read | 列出计划和运行历史。 |
schedules:write | 创建、编辑、删除和运行计划。 |
watchers:read | 列出文件夹监视。 |
watchers:write | 创建、编辑和删除监视。 |
workflows:read | 列出工作流和运行历史。 |
workflows:write | 创建、编辑、删除和运行工作流。 |
parameters:read | 列出和查看全局参数。 |
parameters:write | 创建、编辑和删除全局参数。 |
users:read | 列出和查看用户。 |
users:write | 编辑和删除用户。 |
agents:read | 列出和查看托管代理。 |
agents:write | 创建、编辑、删除和测试托管代理。 |
webhooks:read | 列出 Webhook 和投递记录。 |
webhooks:write | 创建、编辑和删除 Webhook。 |
activity:read | 读取活动日志和仪表板计数。 |
notifications:read | 读取通知设置和通知日志。 |
notifications:write | 编辑或测试通知设置。 |
api-keys:read | 列出 API 密钥。 |
api-keys:write | 在调用密钥所拥有的范围内创建和吊销 API 密钥。 |
API 密钥和 Webhook 需要 Team 或更高套餐。套餐与限制列出了每月允许的 API 请求数。