OpenProject API 自动化 3 种姿势别再手工点重复工单了完整指南【免费下载链接】openprojectOpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub项目地址: https://gitcode.com/GitHub_Trending/op/openproject提交一次代码就要手动录一条工单每天早上还得逐条翻未完结任务发日报OpenProject API 配合 Webhook 可以把这些重复劳动从你手里接管。本文用「拉、推、巡」三种自动化模式带你从拿密钥到上线把重复操作彻底交给脚本。01先拿到钥匙启用 API 并生成 API 密钥自动化跑起来之前先确认两件事服务端的 API 是开着的你自己手里有一把钥匙API 密钥。管理端开启 API 并配置分页与 CORS管理员进入Administration → API and webhooks页面这里集中管理三类设置允许用户创建个人 API 密钥开关关闭时任何人都无法在个人设置里生成密钥最大分页大小maximum page size限制单次 API 响应返回的最大条数批量拉取时别超过这个值CORS 跨域勾选后填写允许的来源域名浏览器端应用才能直接调用 API。注意认证资源不允许*通配必须写具体域名。官方配置说明见 docs/system-admin-guide/api-and-webhooks/README.md。个人端在 API access 页面生成密钥以普通用户身份登录进入Account settings → API access点击生成新密钥。密钥只在生成时完整展示一次立刻存进密码管理器或 CI 的 Secrets 里。之后所有请求都要带 Basic 认证头# 将 用户名:密钥 做 Base64 编码放进 Authorization 头 curl https://你的域名.com/api/v3/projects/1 \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json⚠️ 注意什么密钥等同于该账号的完整操作权限写进脚本前确认它没有权限越界的项目可见性泄露后在同一个页面点 Reset 即可吊销旧密钥。02主动拉一条 curl 管理工作包把「拉」想象成点外卖你饿了自己打开 App 下单、查订单系统被动响应。脚本定期问系统「现在什么状况」拿回数据再自己决定干什么——这是最简单、也最先能用起来的自动化模式。curl 查工作包列表GET# 列出项目 1 下的工作包pageSize 控制每页条数 curl https://你的域名.com/api/v3/projects/1/work_packages?pageSize50 \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json响应是一个集合每个工作包里最常用这几个字段id编号、subject标题、status状态值为链接结构、project/type所属项目与类型。curl 创建工作包POST与更新状态PATCH# POST /api/v3/work_packages 新建一条工单 curl -X POST https://你的域名.com/api/v3/work_packages \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json \ -d { subject: API 创建的工单, # 工单标题必填 description: { raw: 由脚本自动创建 }, # 描述支持 Markdown project: { href: /api/v3/projects/1 }, # 归属项目 type: { href: /api/v3/types/1 }, # 工作包类型 status: { href: /api/v3/statuses/1 } # 初始状态 }# PATCH /api/v3/work_packages/42 只传要改的字段这里改状态 curl -X PATCH https://你的域名.com/api/v3/work_packages/42 \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json \ -d { status: { href: /api/v3/statuses/5 } }注意什么project、type、status这类关联字段一律用href指向对应资源地址而不是直接填数字 ID枚举值有哪些类型、状态可先调/api/v3/types、/api/v3/statuses查清楚再填。03事件推让 OpenProject 用 Webhook「喊你」「推」则像外卖送到门口有人按门铃你不用盯 App系统一有动作就主动通知你。适合「工单一创建就要同步到别处」这类要求实时的场景。配置一个 Webhook 的五个要素在Administration → API and webhooks → Webhooks点 Webhook逐项填要素作用Name名称给 Webhook 起个能辨认的名字如「同步至计费系统」Payload URL事件发生时 OpenProject 向其发送 POST 请求的外部端点Signature secret签名密钥随机字符串用于生成请求签名证明请求真的来自 OpenProjectEvents触发事件如工作包创建/更新、评论、时间记录、附件、项目变更Projects作用项目全部项目或指定项目只有圈定范围内的事件才会触发⚠️ 注意什么签名密钥别留空也别说「先上线后补」。没有签名的 Webhook 端点等于向公网暴露了一个可被任何人伪造的写入入口。带签名校验的接收端示例Node.jsOpenProject 发送请求时会带上X-OP-Signature头格式为sha1HMAC 值用你的签名密钥对请求体做 HMAC-SHA1。接收端必须复算并比对const crypto require(crypto); const app require(express)(); app.post(/openproject-webhook, (req, res) { const body JSON.stringify(req.body); // 用同一个 secret 复算 HMAC-SHA1与请求头比对 const expected sha1 crypto.createHmac(sha1, your-webhook-secret) .update(body).digest(hex); const signature req.headers[x-op-signature]; if (signature ! expected) return res.status(403).end(); // 签名不符直接拒收 const { action, payload } req.body; if (action work_package_updated) { // 拿到事件数据后执行你的业务逻辑比如同步到其他系统 console.log(工作包 ${payload.id} 被更新); } res.status(200).end(); // 尽快返回 2xx重活丢给后台队列 });注意什么处理逻辑要快收到事件先落库再慢慢处理否则响应超时 OpenProject 会按失败重试。事件名action字段以 Webhook 模块的实际实现为准可参考 modules/webhooks/ 下的作业类源码。04定时巡把代码提交与每日报告同步进 OpenProject「巡」是拉和推的组合拳按固定节奏主动检查外部变化再写回 OpenProject。两种最常见的节奏——跟着 Git 提交走和跟着日历走。GitHub Actionspush 时自动创建工单仓库内放一份工作流文件每次推送自动调 OpenProject API 建一条工单把提交信息带过去# .github/workflows/openproject-sync.yml name: 同步提交到 OpenProject on: [push] jobs: create-task: runs-on: ubuntu-latest steps: - name: 创建工作包 run: | curl -X POST https://你的域名.com/api/v3/work_packages \ -H Authorization: Basic ${{ secrets.OP_API_TOKEN }} \ -H Content-Type: application/json \ -d {\subject\:\代码提交: ${{ github.sha }}\, \ \description\:{\raw\:\提交人: ${{ github.actor }}\}, \ \project\:{\href\:\/api/v3/projects/1\}}密钥放在仓库的 SecretsOP_API_TOKEN里不要写死在文件里。cron 每日报告查未完结任务并出报告用filters参数在服务端过滤「状态不是已关闭」的工作包定时抓下来交给脚本出报告# crontab -e 添加每天 09:00 拉取项目 1 中未关闭的工作包 0 9 * * * curl -s https://你的域名.com/api/v3/projects/1/work_packages?filters[{status:{operator:!,values:[closed]}}] \ -H Authorization: Basic U0M6xxxxxxxx \ -o /tmp/op_daily.json python3 generate_report.py /tmp/op_daily.json注意什么过滤尽量放在 URL 的filters里让服务端执行而不是把全量拉回来本地筛——项目大了之后后者的流量和解析成本都不可接受。05上线前的四个细节重试、缓存、批量、安全能跑 ≠ 能上线。这四个点决定了你的自动化半夜会不会悄悄坏掉。错误重试失败先退避再重试网络抖动和瞬时 5xx 很常见裸调一次就报错的脚本会在生产环境反复告警import time, requests def call_op(url, retries3): for attempt in range(retries, -1, -1): try: resp requests.get(url, headersheaders, timeout10) resp.raise_for_status() return resp.json() except requests.RequestException: if attempt 0: raise time.sleep(2 ** (3 - attempt)) # 指数退避4s、2s、1s注意什么重试只适合幂等请求GET、查询类对 POST 建单这类非幂等操作先查一次是否已建成功避免重试刷出一堆重复工单。响应缓存用 ETag 少拉数据对基本不变的数据项目列表、类型与状态枚举带上条件请求头内容没变时服务端返回 304 Not Modified你省下的不只是流量# 首次请求记下 ETag之后请求带上 If-None-Match curl -I https://你的域名.com/api/v3/projects \ -H Authorization: Basic U0M6xxxxxxxx | grep -i etag注意什么缓存枚举类数据可以设长 TTL但工作包列表这种高频变化资源别缓存太久否则会拿着过期数据做决策。批量与分页一次多拿、按页翻完用pageSize参数不超过管理端配置的最大分页大小减少往返次数按响应头里的总条目数翻页直到取完别假设一页就是全部需要复杂筛选条件时可考虑先保存查询再反复取结果而不是每次拼超长 URL。注意什么分页期间若有人新建了数据页与页之间可能出现重复或遗漏对一致性敏感的场景应在拉取前固定快照条件。密钥与签名两端都要守住API 密钥只放环境变量 / CI Secrets / 密码管理器不进代码库、不进日志Webhook 端签名校验放在处理任何业务逻辑之前不匹配直接 403密钥定期轮换人员变动时先吊销再交接。注意什么给自动化脚本单独建一个专用账号权限只圈定它要操作的项目出了问题能精确吊销而不影响真人。06接下来学什么官方文档与进阶资源清单按「配置 → 接口 → 事件」的顺序深入全部是仓库内的官方文档系统管理员指南API and webhooks——API 开关、分页上限、CORS 与 Webhook 全量配置项API v3 说明与 OpenAPI 规范——按 OpenAPI 3.1 编写的完整接口规格任何 OpenProject 实例也可直接从/api/v3/spec.json下载API 文档总入口——各版本 API 的入口与常见问题Webhook 模块源码——事件名、签名算法与派发流程的第一手实现GitHub 集成管理员指南——与第 04 节配合使用的平台级集成。钥匙拿到手只需要十分钟而省下来的时间是以周计的。今晚就选一件你每周都在手动做的事——建单、改状态、发日报——把它变成第一条 curl。【免费下载链接】openprojectOpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub项目地址: https://gitcode.com/GitHub_Trending/op/openproject创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 OpenProject API 自动化 3 种姿势：别再手工点重复工单了（完整指南）
OpenProject API 自动化 3 种姿势别再手工点重复工单了完整指南【免费下载链接】openprojectOpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub项目地址: https://gitcode.com/GitHub_Trending/op/openproject提交一次代码就要手动录一条工单每天早上还得逐条翻未完结任务发日报OpenProject API 配合 Webhook 可以把这些重复劳动从你手里接管。本文用「拉、推、巡」三种自动化模式带你从拿密钥到上线把重复操作彻底交给脚本。01先拿到钥匙启用 API 并生成 API 密钥自动化跑起来之前先确认两件事服务端的 API 是开着的你自己手里有一把钥匙API 密钥。管理端开启 API 并配置分页与 CORS管理员进入Administration → API and webhooks页面这里集中管理三类设置允许用户创建个人 API 密钥开关关闭时任何人都无法在个人设置里生成密钥最大分页大小maximum page size限制单次 API 响应返回的最大条数批量拉取时别超过这个值CORS 跨域勾选后填写允许的来源域名浏览器端应用才能直接调用 API。注意认证资源不允许*通配必须写具体域名。官方配置说明见 docs/system-admin-guide/api-and-webhooks/README.md。个人端在 API access 页面生成密钥以普通用户身份登录进入Account settings → API access点击生成新密钥。密钥只在生成时完整展示一次立刻存进密码管理器或 CI 的 Secrets 里。之后所有请求都要带 Basic 认证头# 将 用户名:密钥 做 Base64 编码放进 Authorization 头 curl https://你的域名.com/api/v3/projects/1 \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json⚠️ 注意什么密钥等同于该账号的完整操作权限写进脚本前确认它没有权限越界的项目可见性泄露后在同一个页面点 Reset 即可吊销旧密钥。02主动拉一条 curl 管理工作包把「拉」想象成点外卖你饿了自己打开 App 下单、查订单系统被动响应。脚本定期问系统「现在什么状况」拿回数据再自己决定干什么——这是最简单、也最先能用起来的自动化模式。curl 查工作包列表GET# 列出项目 1 下的工作包pageSize 控制每页条数 curl https://你的域名.com/api/v3/projects/1/work_packages?pageSize50 \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json响应是一个集合每个工作包里最常用这几个字段id编号、subject标题、status状态值为链接结构、project/type所属项目与类型。curl 创建工作包POST与更新状态PATCH# POST /api/v3/work_packages 新建一条工单 curl -X POST https://你的域名.com/api/v3/work_packages \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json \ -d { subject: API 创建的工单, # 工单标题必填 description: { raw: 由脚本自动创建 }, # 描述支持 Markdown project: { href: /api/v3/projects/1 }, # 归属项目 type: { href: /api/v3/types/1 }, # 工作包类型 status: { href: /api/v3/statuses/1 } # 初始状态 }# PATCH /api/v3/work_packages/42 只传要改的字段这里改状态 curl -X PATCH https://你的域名.com/api/v3/work_packages/42 \ -H Authorization: Basic U0M6xxxxxxxx \ -H Content-Type: application/json \ -d { status: { href: /api/v3/statuses/5 } }注意什么project、type、status这类关联字段一律用href指向对应资源地址而不是直接填数字 ID枚举值有哪些类型、状态可先调/api/v3/types、/api/v3/statuses查清楚再填。03事件推让 OpenProject 用 Webhook「喊你」「推」则像外卖送到门口有人按门铃你不用盯 App系统一有动作就主动通知你。适合「工单一创建就要同步到别处」这类要求实时的场景。配置一个 Webhook 的五个要素在Administration → API and webhooks → Webhooks点 Webhook逐项填要素作用Name名称给 Webhook 起个能辨认的名字如「同步至计费系统」Payload URL事件发生时 OpenProject 向其发送 POST 请求的外部端点Signature secret签名密钥随机字符串用于生成请求签名证明请求真的来自 OpenProjectEvents触发事件如工作包创建/更新、评论、时间记录、附件、项目变更Projects作用项目全部项目或指定项目只有圈定范围内的事件才会触发⚠️ 注意什么签名密钥别留空也别说「先上线后补」。没有签名的 Webhook 端点等于向公网暴露了一个可被任何人伪造的写入入口。带签名校验的接收端示例Node.jsOpenProject 发送请求时会带上X-OP-Signature头格式为sha1HMAC 值用你的签名密钥对请求体做 HMAC-SHA1。接收端必须复算并比对const crypto require(crypto); const app require(express)(); app.post(/openproject-webhook, (req, res) { const body JSON.stringify(req.body); // 用同一个 secret 复算 HMAC-SHA1与请求头比对 const expected sha1 crypto.createHmac(sha1, your-webhook-secret) .update(body).digest(hex); const signature req.headers[x-op-signature]; if (signature ! expected) return res.status(403).end(); // 签名不符直接拒收 const { action, payload } req.body; if (action work_package_updated) { // 拿到事件数据后执行你的业务逻辑比如同步到其他系统 console.log(工作包 ${payload.id} 被更新); } res.status(200).end(); // 尽快返回 2xx重活丢给后台队列 });注意什么处理逻辑要快收到事件先落库再慢慢处理否则响应超时 OpenProject 会按失败重试。事件名action字段以 Webhook 模块的实际实现为准可参考 modules/webhooks/ 下的作业类源码。04定时巡把代码提交与每日报告同步进 OpenProject「巡」是拉和推的组合拳按固定节奏主动检查外部变化再写回 OpenProject。两种最常见的节奏——跟着 Git 提交走和跟着日历走。GitHub Actionspush 时自动创建工单仓库内放一份工作流文件每次推送自动调 OpenProject API 建一条工单把提交信息带过去# .github/workflows/openproject-sync.yml name: 同步提交到 OpenProject on: [push] jobs: create-task: runs-on: ubuntu-latest steps: - name: 创建工作包 run: | curl -X POST https://你的域名.com/api/v3/work_packages \ -H Authorization: Basic ${{ secrets.OP_API_TOKEN }} \ -H Content-Type: application/json \ -d {\subject\:\代码提交: ${{ github.sha }}\, \ \description\:{\raw\:\提交人: ${{ github.actor }}\}, \ \project\:{\href\:\/api/v3/projects/1\}}密钥放在仓库的 SecretsOP_API_TOKEN里不要写死在文件里。cron 每日报告查未完结任务并出报告用filters参数在服务端过滤「状态不是已关闭」的工作包定时抓下来交给脚本出报告# crontab -e 添加每天 09:00 拉取项目 1 中未关闭的工作包 0 9 * * * curl -s https://你的域名.com/api/v3/projects/1/work_packages?filters[{status:{operator:!,values:[closed]}}] \ -H Authorization: Basic U0M6xxxxxxxx \ -o /tmp/op_daily.json python3 generate_report.py /tmp/op_daily.json注意什么过滤尽量放在 URL 的filters里让服务端执行而不是把全量拉回来本地筛——项目大了之后后者的流量和解析成本都不可接受。05上线前的四个细节重试、缓存、批量、安全能跑 ≠ 能上线。这四个点决定了你的自动化半夜会不会悄悄坏掉。错误重试失败先退避再重试网络抖动和瞬时 5xx 很常见裸调一次就报错的脚本会在生产环境反复告警import time, requests def call_op(url, retries3): for attempt in range(retries, -1, -1): try: resp requests.get(url, headersheaders, timeout10) resp.raise_for_status() return resp.json() except requests.RequestException: if attempt 0: raise time.sleep(2 ** (3 - attempt)) # 指数退避4s、2s、1s注意什么重试只适合幂等请求GET、查询类对 POST 建单这类非幂等操作先查一次是否已建成功避免重试刷出一堆重复工单。响应缓存用 ETag 少拉数据对基本不变的数据项目列表、类型与状态枚举带上条件请求头内容没变时服务端返回 304 Not Modified你省下的不只是流量# 首次请求记下 ETag之后请求带上 If-None-Match curl -I https://你的域名.com/api/v3/projects \ -H Authorization: Basic U0M6xxxxxxxx | grep -i etag注意什么缓存枚举类数据可以设长 TTL但工作包列表这种高频变化资源别缓存太久否则会拿着过期数据做决策。批量与分页一次多拿、按页翻完用pageSize参数不超过管理端配置的最大分页大小减少往返次数按响应头里的总条目数翻页直到取完别假设一页就是全部需要复杂筛选条件时可考虑先保存查询再反复取结果而不是每次拼超长 URL。注意什么分页期间若有人新建了数据页与页之间可能出现重复或遗漏对一致性敏感的场景应在拉取前固定快照条件。密钥与签名两端都要守住API 密钥只放环境变量 / CI Secrets / 密码管理器不进代码库、不进日志Webhook 端签名校验放在处理任何业务逻辑之前不匹配直接 403密钥定期轮换人员变动时先吊销再交接。注意什么给自动化脚本单独建一个专用账号权限只圈定它要操作的项目出了问题能精确吊销而不影响真人。06接下来学什么官方文档与进阶资源清单按「配置 → 接口 → 事件」的顺序深入全部是仓库内的官方文档系统管理员指南API and webhooks——API 开关、分页上限、CORS 与 Webhook 全量配置项API v3 说明与 OpenAPI 规范——按 OpenAPI 3.1 编写的完整接口规格任何 OpenProject 实例也可直接从/api/v3/spec.json下载API 文档总入口——各版本 API 的入口与常见问题Webhook 模块源码——事件名、签名算法与派发流程的第一手实现GitHub 集成管理员指南——与第 04 节配合使用的平台级集成。钥匙拿到手只需要十分钟而省下来的时间是以周计的。今晚就选一件你每周都在手动做的事——建单、改状态、发日报——把它变成第一条 curl。【免费下载链接】openprojectOpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub项目地址: https://gitcode.com/GitHub_Trending/op/openproject创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考