REST API
A API REST do TodoMate permite gerir as tuas tarefas, objetivos e visão a partir de qualquer cliente HTTP. Este guia mostra como obter um token e fazer o teu primeiro pedido com curl.
Pré-requisitos
- Uma conta em todo.ac (início de sessão com GitHub)
- Uma subscrição Pro — necessária para gerar uma chave API
Passo 1 — Instalar o GitHub CLI
A forma mais fácil de obter um token de acesso do GitHub é com o GitHub CLI.
# macOS
brew install gh
# Windows
winget install GitHub.cli
# Linux — consulta https://github.com/cli/cli/blob/trunk/docs/install_linux.md
Passo 2 — Obter um token de acesso do GitHub
gh auth login
gh auth token
Copia o token apresentado — vais precisar dele no Passo 4.
Passo 3 — Obter a tua chave API
A tua chave API autentica o teu cliente na API.
- Abre todo.ac
- Vai a Conta → Chaves API
- Toca em Gerar chave, dá-lhe um nome e copia o valor — é mostrado apenas uma vez
Passo 4 — Obter um JWT do TodoMate
Troca o teu token do GitHub por um JWT de curta duração:
JWT=$(curl -s -X POST https://api.todo.ac/v1/auth/token \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: A_TUA_CHAVE_API" \
-d '{"github_token": "O_TEU_TOKEN_GITHUB"}' \
| jq -r '.access_token')
echo $JWT
Nota:
jqé usado aqui para processar a resposta JSON. Instala combrew install jqou o teu gestor de pacotes.
Passo 5 — Listar as tuas tarefas
curl https://api.todo.ac/v1/todos \
-H "Authorization: Bearer $JWT" \
-H "Ocp-Apim-Subscription-Key: A_TUA_CHAVE_API"
Deves receber um array JSON com as tuas tarefas.
Próximos passos
Explora a Referência da API completa para descobrir todos os endpoints disponíveis — tarefas, objetivos, visão e muito mais.