值守与反馈
在会话里把仓库接入项目值守,查看项目的反馈单。
以下接口的完整地址都以 https://api.yqpj.com/app-api/project/open-api 开头,请求头带 X-Api-Key: <你的密钥>。只能操作你是创建者或已接受开发者的项目。
POST /agent/attach 接入值守
找到项目,没有处理端就注册一个,换发新的处理端令牌,并记下仓库、分支和机器。
所需权限:接入值守(AGENT_MANAGE)。对应命令:在项目仓库里执行 yqpj-agent attach [项目名 | 业务编号 | 编号],仓库路径、分支、机器名、远端地址由命令自动填写。
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
projectId | 数字 | 否 | 项目编号 |
project | 文本 | 否 | 项目名称或业务编号;与 projectId 二选一 |
repoRemote | 文本 | 否 | 仓库的 git 远端地址(origin) |
branch | 文本 | 否 | 当前分支 |
repoPath | 文本 | 否 | 本机仓库路径(git 根目录) |
machine | 文本 | 否 | 机器名 |
请求示例
{
"project": "钱包服务",
"repoRemote": "[email protected]:acme/wallet.git",
"branch": "master",
"repoPath": "/Users/me/Project/wallet",
"machine": "my-macbook"
}返回示例
{
"code": 0,
"data": {
"agentId": 12,
"tenantId": 1,
"agentName": "钱包服务·反馈值守",
"projectId": 34,
"projectName": "钱包服务",
"repoPath": "/Users/me/Project/wallet",
"branch": "master",
"token": "<新处理端令牌>"
},
"msg": ""
}规则说明
- 找项目:先看
projectId,再看project(名称或业务编号精确匹配优先,其次名称包含);都没给时按「仓库 + 分支」找已绑定的项目,最后按登记过的本机路径兜底。找不到或不唯一时返回错误,并附带可选项目列表。 - 记住仓库:给了远端地址时,平台记下「仓库 + 分支 → 项目」的绑定,以后在这个仓库里不写项目名也能认出来。
- 令牌只返回这一次:每次接入都换发新令牌,旧令牌立即失效。处理端会被设为启用。
- 机器:只记录上报过的机器,不会锁定处理电脑;处理电脑在 H5 单独指定。
- 接入成功后,项目所在团队会收到处理端已接入的通知。
GET /feedback 项目反馈单
查看一个项目最近的 50 张反馈单。
所需权限:查看反馈(FEEDBACK_READ),且你能处理该项目的反馈。对应命令:命令行暂无对应命令。
请求参数(查询串)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
projectId | 数字 | 是 | 项目编号 |
status | 枚举 | 否 | 按状态筛选:NEW 待处理 / PROCESSING 处理中 / WAITING_REPORTER 待补充 / RESOLVED 已解决 / CLOSED 已关闭 / CANCELED 已撤销 |
请求示例
GET /app-api/project/open-api/feedback?projectId=34&status=NEW返回示例
{
"code": 0,
"data": [
{
"id": 301,
"no": "#F6",
"title": "提现页面点击无反应",
"status": "NEW",
"category": "BUG",
"needHuman": false,
"createTime": 1792656000000
}
],
"msg": ""
}单号前缀区分类型,问题反馈是
#F,需求单是 #R。最多返回 50 张,不支持翻页。