Siirry pääsisältöön

REST API

TodoMate REST API:n avulla voit hallita tehtäviäsi, tavoitteitasi ja visiotasi mistä tahansa HTTP-asiakkaasta. Tämä opas näyttää, miten saat tokenin ja teet ensimmäisen pyyntösi curl-komennolla.

Edellytykset​

  • Tili todo.ac-palvelussa (kirjaudu GitHubilla)
  • Pro-tilaus — vaaditaan API-avaimen luomiseen

Vaihe 1 — Asenna GitHub CLI​

Helpoin tapa saada GitHub-käyttöoikeustunnus on GitHub CLI.

# macOS
brew install gh

# Windows
winget install GitHub.cli

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

Vaihe 2 — Hanki GitHub-käyttöoikeustunnus​

gh auth login
gh auth token

Kopioi tulostunut tunnus — tarvitset sen vaiheessa 4.

Vaihe 3 — Hanki API-avaimesi​

API-avain todentaa asiakkaasi API:lle.

  1. Avaa todo.ac
  2. Siirry kohtaan Tili → API-avaimet
  3. Napauta Luo avain, anna sille nimi ja kopioi arvo — se näytetään vain kerran

Vaihe 4 — Hanki TodoMate JWT​

Vaihda GitHub-tunnuksesi lyhytikäiseen JWT:hen:

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

echo $JWT

Huom: jq-työkalua käytetään JSON-vastauksen jäsentämiseen. Asenna se komennolla brew install jq tai paketinhallinnallasi.

Vaihe 5 — Listaa tehtäväsi​

curl https://api.todo.ac/v1/todos \
  -H "Authorization: Bearer $JWT" \
  -H "Ocp-Apim-Subscription-Key: OMA_API_AVAIMESI"

Sinun pitäisi saada JSON-taulukko tehtävistäsi.

Seuraavat vaiheet​

Selaa koko API-viitettä tutkiaksesi kaikkia saatavilla olevia päätepisteitä — tehtävät, tavoitteet, visio ja paljon muuta.