REST API
API ya REST ya TodoMate inakuruhusu kusimamia kazi, malengo, na maono kutoka kwa mteja yoyote wa HTTP. Mwongozo huu unaelezea jinsi ya kupata tokeni na kutuma ombi la kwanza kwa kutumia curl.
Mahitaji
- Akaunti kwenye todo.ac (ingia kwa GitHub)
- Mpango wa Pro — unahitajika kuunda ufunguo wa API
Hatua ya 1 — Sakinisha GitHub CLI
Njia rahisi zaidi ya kupata tokeni ya ufikiaji ya GitHub ni kutumia GitHub CLI.
# macOS
brew install gh
# Windows
winget install GitHub.cli
# Linux — angalia https://github.com/cli/cli/blob/trunk/docs/install_linux.md
Hatua ya 2 — Pata tokeni ya ufikiaji ya GitHub
gh auth login
gh auth token
Nakili tokeni iliyoonyeshwa — utaihitaji katika Hatua ya 4.
Hatua ya 3 — Pata ufunguo wako wa API
Ufunguo wa API unathibitisha mteja wako kwa API.
- Fungua todo.ac
- Nenda kwenye Akaunti → Funguo za API
- Gonga Unda ufunguo, ipe jina, na nakili thamani — inaonyeshwa mara moja tu
Hatua ya 4 — Pata JWT ya TodoMate
Badilisha tokeni yako ya GitHub na JWT ya muda mfupi:
JWT=$(curl -s -X POST https://api.todo.ac/v1/auth/token \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: UFUNGUO_WAKO_WA_API" \
-d '{"github_token": "TOKENI_YAKO_YA_GITHUB"}' \
| jq -r '.access_token')
echo $JWT
Kumbuka:
jqinatumika kuchambua jibu la JSON. Sakinisha kwabrew install jqau msimamia wako wa pakiti.
Hatua ya 5 — Orodhesha kazi zako
curl https://api.todo.ac/v1/todos \
-H "Authorization: Bearer $JWT" \
-H "Ocp-Apim-Subscription-Key: UFUNGUO_WAKO_WA_API"
Unapaswa kupata safu ya JSON iliyo na kazi zako.
Hatua zinazofuata
Angalia Marejeo ya API kamili ili kuchunguza vituo vyote vinavyopatikana — kazi, malengo, maono, na zaidi.