使用个人访问令牌的 REST API
在“设置”的“开发者”中创建令牌。可以只授予所需的权限和项目，并设置有效期。令牌在一个组织内代表你运行，绝不能做超出你权限的事。OpenAPI 3.1 规范说明了所有路径。
包括免费版在内的所有方案
curl https://api.onplana.com/api/tasks/mine \
-H "Authorization: Bearer pat_YOUR_TOKEN"面向开发者
在 Onplana 之上构建
用代码读写项目和任务，即时获知变化，把计划拉进报表，并让 AI 智能体去完成工作。共有 5 个入口，都使用代表创建者本人运行的令牌。
5 个入口
今天就都能用。从示例开始，再进入各自的指南。
签名 Webhook
当 22 种事件中的任意一种发生时，Onplana 会把 JSON 负载 POST 到你的 URL。每次投递都带有用你的密钥生成的正文 HMAC-SHA256 签名，每次尝试都记录在投递历史中。
Business 方案及以上
curl -X POST https://api.onplana.com/api/webhooks \
-H "Authorization: Bearer pat_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Status changes","url":"https://example.com/onplana","events":["task.status_changed"],"secret":"YOUR_SECRET"}'OData 报表源
只读的 OData v4 数据源，包含项目、任务、分配、资源、工时表行、自定义字段值和基线。可从 Power BI、Excel 或数据仓库，用具有报表权限的令牌连接。
Professional 方案及以上
curl -u "token:pat_YOUR_TOKEN" \
"https://api.onplana.com/api/odata/Tasks?$top=5"面向 AI 智能体的 MCP 服务器
Claude、ChatGPT、Cursor 等 MCP 客户端，可以凭连接者的权限读取和管理工作。客户端在浏览器中登录，因此无需事先注册应用。
包括免费版在内的所有方案。可同时连接的智能体数量随方案增加。
{
"mcpServers": {
"onplana": { "url": "https://mcp.onplana.com/mcp" }
}
}连接器
动手构建之前，先看看是否已有现成的集成。每个连接器都用个人访问令牌登录，并先进行同样的检查。
- Microsoft Teams 和 Microsoft 365 Copilot：包括免费版在内的所有方案可用。
- 任务中的 SharePoint 和 OneDrive 文件链接：Professional 方案及以上可用。
- Power Automate 和 Power Apps：连接器已基于同一 API 构建，尚未发布。
- Zapier：应用已基于同一 API 构建，尚未发布。
连接器的触发器订阅 Webhook：Business 方案及以上。
curl https://api.onplana.com/api/organizations/current \
-H "Authorization: Bearer pat_YOUR_TOKEN"请求如何工作
- 以 Bearer 令牌的形式发送令牌。令牌绑定到创建它的组织，因此请求无需组织请求头。
- 错误以 JSON 返回，包含可显示的句子、代码，以及联系支持时提供的 requestId。
- 限制按路径组设定。被拒绝的请求返回 429 和以秒为单位的 Retry-After 请求头，请等待该时间后重试。
- 规范位于 api.onplana.com/api/openapi.json，可以据此生成任意语言的客户端。
各入口所需的方案
这些信息读取自价格表，因此本列表与价格页面始终一致。
| 使用的内容 | 方案 |
|---|---|
| REST API 和个人访问令牌 | 包括免费版在内的所有方案 |
| Webhook | Business 方案及以上 |
| OData 报表源 | Professional 方案及以上 |
| MCP 服务器 | 包括免费版在内的所有方案 |
| Microsoft Teams 应用和 Copilot 智能体 | 包括免费版在内的所有方案 |
| SharePoint 和 OneDrive 文件链接 | Professional 方案及以上 |
| 连接器触发器（订阅 Webhook） | Business 方案及以上 |
开发者的问题
有 SDK 吗？
没有。API 是基于 HTTPS 的 JSON，并有 OpenAPI 3.1 规范，任何 HTTP 客户端都可以使用。也可以根据规范生成带类型的客户端。
API 另外收费吗？
不收费。REST API 和令牌在包括免费版在内的所有方案中可用。Webhook 在Business 方案及以上中可用，OData 数据源在Professional 方案及以上中可用。
能否从服务器应用代表许多客户进行操作？
目前还不能通过 OAuth 实现。现在每位客户为自己的集成创建令牌，该令牌代表创建者本人运行。如果你的产品需要更多能力，请告诉我们具体内容。
API 使用条款在哪里？
开发者文档中的 API 使用条款页面说明了允许的用途、令牌代表什么，以及如何通知不兼容的变更。