Zum Hauptinhalt springen

REST API

Die TodoMate REST API ermöglicht es dir, deine Aufgaben, Ziele und Vision von jedem HTTP-Client aus zu verwalten. Diese Anleitung zeigt dir, wie du einen Token erhältst und deine erste Anfrage mit curl sendest.

Voraussetzungen​

  • Ein Konto auf todo.ac (Anmeldung mit GitHub)
  • Ein Pro-Abonnement — erforderlich, um einen API-Schlüssel zu generieren

Schritt 1 — GitHub CLI installieren​

Der einfachste Weg, einen GitHub-Zugriffstoken zu erhalten, ist die GitHub CLI.

# macOS
brew install gh

# Windows
winget install GitHub.cli

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

Schritt 2 — GitHub-Zugriffstoken erhalten​

gh auth login
gh auth token

Kopiere den angezeigten Token — du brauchst ihn in Schritt 4.

Schritt 3 — API-Schlüssel erhalten​

Dein API-Schlüssel authentifiziert deinen Client gegenüber der API.

  1. Öffne todo.ac
  2. Gehe zu Konto → API-Schlüssel
  3. Tippe auf Schlüssel generieren, gib ihm einen Namen und kopiere den Wert — er wird nur einmal angezeigt

Schritt 4 — TodoMate JWT erhalten​

Tausche deinen GitHub-Token gegen einen kurzlebigen JWT:

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

echo $JWT

Hinweis: jq wird hier verwendet, um die JSON-Antwort zu verarbeiten. Installiere es mit brew install jq oder deinem Paketmanager.

Schritt 5 — Aufgaben auflisten​

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

Du solltest ein JSON-Array mit deinen Aufgaben erhalten.

Nächste Schritte​

Durchsuche die vollständige API-Referenz, um alle verfügbaren Endpunkte zu erkunden — Aufgaben, Ziele, Vision und mehr.