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 に対して認証します。
- todo.ac を開く
- アカウント → API キー に移動する
- キーを生成 をタップして名前を付け、値をコピーする — 一度しか表示されません
ステップ 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 リファレンス 全体を参照して、利用可能なすべてのエンドポイント(タスク、目標、ビジョンなど)を確認してください。