REST API

TodoMate REST API 让你可以从任意 HTTP 客户端管理待办事项、目标和愿景。本指南介绍如何获取令牌并使用 curl 发送第一个请求。

前提条件

• todo.ac 账户（使用 GitHub 登录）
• Pro 订阅 — 生成 API 密钥所需

第 1 步 — 安装 GitHub CLI

获取 GitHub 访问令牌最简单的方法是使用 GitHub CLI。

# macOS
brew install gh

# Windows
winget install GitHub.cli

# Linux — 参见 https://github.com/cli/cli/blob/trunk/docs/install_linux.md

第 2 步 — 获取 GitHub 访问令牌

gh auth login
gh auth token

复制显示的令牌 — 你将在第 4 步中用到它。

第 3 步 — 获取你的 API 密钥

API 密钥用于向 API 验证你的客户端身份。

1. 打开 todo.ac
2. 进入 账户 → API 密钥
3. 点击 生成密钥，为其命名并复制值 — 仅显示一次

第 4 步 — 获取 TodoMate JWT

将你的 GitHub 令牌换取短期 JWT：

JWT=$(curl -s -X POST https://api.todo.ac/v1/auth/token \
  -H "Content-Type: application/json" \
  -H "Ocp-Apim-Subscription-Key: 你的API密钥" \
  -d '{"github_token": "你的GitHub令牌"}' \
  | jq -r '.access_token')

echo $JWT

注意： 这里使用 jq 解析 JSON 响应。通过 brew install jq 或你的包管理器安装。

第 5 步 — 列出你的待办事项

curl https://api.todo.ac/v1/todos \
  -H "Authorization: Bearer $JWT" \
  -H "Ocp-Apim-Subscription-Key: 你的API密钥"

你应该会收到包含你的待办事项的 JSON 数组。

下一步

浏览完整的 API 参考，探索所有可用的端点 — 待办事项、目标、愿景等。