API参考
SprintFlint 提供 REST API，用于以编程方式访问您的项目、冲刺和工单。使用它与 Zapier、自定义脚本或您自己的应用程序集成。
认证
所有 API 请求都需要使用不记名令牌进行身份验证。
生成 API 代币
- 单击侧边栏中的头像
- 前往“我的个人资料”
- 滚动到“API 代币”部分
- 点击“生成令牌”
- 复制并安全存储您的令牌
令牌安全 - 您的 API 令牌提供与您登录帐户相同的访问权限。保密并且永远不要将其提交给版本控制。
使用令牌
将令牌包含在 Authorization 每个请求的标头：
Authorization: Bearer your-api-token-here带有 cURL 的示例：
curl -H "Authorization: Bearer your-api-token" \
https://sprintflint.com/api/v1/projects基本网址
https://sprintflint.com/api/v1响应格式
所有回复均采用 JSON 格式。成功的响应返回请求的数据。错误响应包括错误消息：
{
"error": "Resource not found"
}可用端点
项目
| 方法 | 端点 | 描述 |
|---|---|---|
GET |
/projects |
列出所有项目 |
GET |
/projects/:id |
获取具体项目 |
POST |
/projects |
创建一个新项目 |
PUT |
/projects/:id |
更新项目 |
DELETE |
/projects/:id |
删除项目 |
冲刺
| 方法 | 端点 | 描述 |
|---|---|---|
GET |
/projects/:project_id/sprints |
列出项目中的冲刺 |
GET |
/projects/:project_id/sprints/:id |
获得特定的冲刺 |
POST |
/projects/:project_id/sprints |
创建新的冲刺 |
PUT |
/projects/:project_id/sprints/:id |
更新冲刺 |
POST |
/projects/:project_id/sprints/:sprint_id/activation |
激活冲刺 |
POST |
/projects/:project_id/sprints/:sprint_id/completion |
完成一次冲刺 |
DELETE |
/projects/:project_id/sprints/:id |
删除冲刺 |
工单
| 方法 | 端点 | 描述 |
|---|---|---|
GET |
/projects/:project_id/issues |
列出未提交的项目待办列表工单 |
POST |
/projects/:project_id/issues |
创建未提交的项目待办列表工单 |
PATCH |
/projects/:project_id/issues/:id |
更新项目工单（包括进入冲刺） |
GET |
/projects/:project_id/sprints/:sprint_id/issues |
列出冲刺中的工单 |
GET |
/projects/:project_id/sprints/:sprint_id/issues/:id |
获取具体工单 |
POST |
/projects/:project_id/sprints/:sprint_id/issues |
创建一个新工单 |
PUT |
/projects/:project_id/sprints/:sprint_id/issues/:id |
更新一个工单 |
DELETE |
/projects/:project_id/sprints/:sprint_id/issues/:id |
删除工单 |
评论
| 方法 | 端点 | 描述 |
|---|---|---|
GET |
/.../issues/:issue_id/comments |
列出对某个工单的评论 |
POST |
/.../issues/:issue_id/comments |
对工单添加评论 |
GET |
/comments/:id |
获取具体评论 |
PUT |
/comments/:id |
更新一条评论 |
DELETE |
/comments/:id |
删除评论 |
示例：创建工单
curl -X POST \
-H "Authorization: Bearer your-api-token" \
-H "Content-Type: application/json" \
-d '{
"issue": {
"title": "Add user authentication",
"description": "Implement login and logout functionality",
"story_points": 5,
"status": "todo"
}
}' \
https://sprintflint.com/api/v1/projects/1/sprints/1/issues示例：更新工单状态
curl -X PUT \
-H "Authorization: Bearer your-api-token" \
-H "Content-Type: application/json" \
-d '{
"issue": {
"status": "in_progress"
}
}' \
https://sprintflint.com/api/v1/projects/1/sprints/1/issues/123速率限制
API 请求受到速率限制以防止滥用：
- 每小时 1000 个请求 每个 API 代币
- 速率限制标头包含在响应中
交互式 API 文档
有关详细的请求/响应模式以及直接测试端点的能力：
重新生成您的令牌
如果您的令牌被泄露：
- 前往“我的个人资料”
- 点击“重新生成令牌”
- 旧令牌立即失效
- 使用新令牌更新您的集成
需要帮助吗？
如果您对 API 有疑问或需要集成方面的帮助，请通过以下方式联系我们： [email protected].