人工智能整合
使用 REST API 将您的 AI 编码助手直接连接到 SprintFlint。无需离开编辑器即可获取分配的工单、更新状态并添加评论。
MCP 感知编辑器? 大多数用户都希望 MCP 服务器位于 mcp.sprintflint.com 相反;将一个 JSON 块放入 Claude Desktop、Cursor、Claude Code 或 Zed 代理与 SprintFlint 进行本地对话。本页涵盖了 MCP 不适合的任何内容的较低级别 REST API。
它是如何运作的
人工智能助手喜欢 Cursor 和 克洛德 可以使用 SprintFlint 的 REST API 直接处理您的工单。使用代理技能或自定义工具让您的 AI 访问您的冲刺数据。
API 端点
SprintFlint 提供以下 REST API 端点:
| 端点 | 方法 | 描述 |
|---|---|---|
/api/v1/projects |
获取、发布 | 列出并创建项目 |
/api/v1/projects/:id |
获取、修补、删除 | 获取、更新或删除项目 |
/api/v1/projects/:id/sprints |
获取、发布 | 列出并创建冲刺 |
/api/v1/projects/:id/sprints/:id |
获取、修补、删除 | 获取、更新或删除 冲刺 |
/api/v1/projects/:id/sprints/:id/issues |
获取、发布 | 列出并创建工单 |
/api/v1/projects/:id/sprints/:id/issues/:id |
获取、修补、删除 | 获取、更新或删除工单 |
/api/v1/.../issues/:id/comments |
获取、发布 | 列出并创建评论 |
/api/v1/comments/:id |
获取、修补、删除 | 获取、更新或删除评论 |
设置
1.生成API代币
- 单击侧边栏中的头像
- 前往“我的个人资料”
- 滚动到“API 代币”部分
- 点击“生成令牌”
- 复制并安全存储您的令牌
2.使用API
将您的令牌包含在 X-API-Token 标头:
curl -H "X-API-Token: YOUR_API_TOKEN" \
https://sprintflint.com/api/v1/projects
3. 配置你的AI助手
添加 SprintFlint 代理技能 到您的 AI 助手,或创建调用 REST API 的自定义工具。
令牌安全 - 您的 API 令牌提供与您登录帐户相同的访问权限。保密并且永远不要将其提交给版本控制。
使用示例
配置完成后,您可以向 AI 助手询问以下问题:
- “当前冲刺中有哪些工单?”
- “显示 PROJ-123 的详细信息”
- “将 PROJ-123 状态更新为 in_progress”
- “向 PROJ-123 添加评论:开始进行 API 集成”
- “创建一个新工单:修复登录按钮样式”
API 调用示例
列出项目
GET /api/v1/projects
X-API-Token: YOUR_TOKEN
创建工单
POST /api/v1/projects/1/sprints/1/issues
X-API-Token: YOUR_TOKEN
Content-Type: application/json
{
"issue": {
"title": "Fix login button",
"status": "todo",
"story_points": 2
}
}
更新工单状态
PATCH /api/v1/projects/1/sprints/1/issues/123
X-API-Token: YOUR_TOKEN
Content-Type: application/json
{
"issue": {
"status": "done"
}
}
添加评论
POST /api/v1/projects/1/sprints/1/issues/123/comments
X-API-Token: YOUR_TOKEN
Content-Type: application/json
{
"comment": {
"body": "Started working on this ticket"
}
}
典型工作流程
- 开始新的一天 - 列出当前冲刺中的工单
- 选择一张票 - 获取特定工单的详细信息
- 开始工作 - 将状态更新为
in_progress - 跟踪进度 - 在工作时添加评论
- 完成 - 将状态更新为
done
完整的 API 文档
有关完整的 API 文档(包括请求/响应模式),请参阅 API参考.
故障排除
身份验证错误
如果您收到“无效的 API 令牌”错误:
- 检查您的令牌是否已正确复制(没有多余的空格)
- 验证令牌尚未重新生成
- 确保标头格式为
X-API-Token: YOUR_TOKEN
404 未找到
如果没有找到资源:
- 检查您是否有权访问项目/冲刺
- 验证您请求中的 ID 是否正确
需要帮助吗?
如果您对 AI 集成有疑问或需要帮助,请通过以下方式联系我们: [email protected].