REST API
TodoMate REST API ช่วยให้คุณจัดการงาน เป้าหมาย และวิสัยทัศน์จาก HTTP client ใดก็ได้ คู่มือนี้อธิบายวิธีรับ token และส่งคำขอแรกด้วย curl
ข้อกำหนดเบื้องต้น
- บัญชีที่ todo.ac (เข้าสู่ระบบด้วย GitHub)
- การสมัครสมาชิก Pro — จำเป็นสำหรับการสร้าง API key
ขั้นตอนที่ 1 — ติดตั้ง GitHub CLI
วิธีที่ง่ายที่สุดในการรับ GitHub access token คือใช้ 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 access token
gh auth login
gh auth token
คัดลอก token ที่แสดงขึ้นมา — คุณจะใช้ในขั้นตอนที่ 4
ขั้นตอนที่ 3 — รับ API key ของคุณ
API key ใช้ยืนยันตัวตน client ของคุณกับ API
- เปิด todo.ac
- ไปที่ บัญชี → API Keys
- แตะ สร้าง key ตั้งชื่อ และคัดลอกค่า — แสดงเพียงครั้งเดียว
ขั้นตอนที่ 4 — รับ TodoMate JWT
แลก GitHub token ของคุณเป็น JWT อายุสั้น:
JWT=$(curl -s -X POST https://api.todo.ac/v1/auth/token \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: API_KEY_ของคุณ" \
-d '{"github_token": "GITHUB_TOKEN_ของคุณ"}' \
| jq -r '.access_token')
echo $JWT
หมายเหตุ:
jqใช้สำหรับแยกวิเคราะห์ JSON response ติดตั้งด้วยbrew install jqหรือตัวจัดการแพ็กเกจของคุณ
ขั้นตอนที่ 5 — แสดงรายการงานของคุณ
curl https://api.todo.ac/v1/todos \
-H "Authorization: Bearer $JWT" \
-H "Ocp-Apim-Subscription-Key: API_KEY_ของคุณ"
คุณควรได้รับ JSON array ที่มีงานของคุณ
ขั้นตอนถัดไป
เรียกดู เอกสาร API ฉบับเต็มเพื่อสำรวจ endpoint ทั้งหมดที่มี — งาน เป้าหมาย วิสัยทัศน์ และอื่นๆ