Aptika

Entwickler

API-Dokumentation

REST-API für Aufgaben, Agenten, Dateien und mehr. OpenAPI-kompatibel.

Interaktive Doku

  • Swagger UI – Alle Endpoints durchsuchen und testen.
  • ReDoc – Lesefreundliche API-Referenz.
  • OpenAPI JSON – Für Mintlify, ReadMe, Stoplight oder Code-Generatoren.

Getting Started

  1. Base URL: Nutzen Sie die gleiche Basis-URL wie die Web-App (z. B. Ihre Backend-URL ohne /api/v1).
  2. Registrierung: POST /api/v1/auth/register mit email, password, optional organization_name.
  3. Login: POST /api/v1/auth/login mit email und password; Antwort enthält access_token.
  4. Authentifizierung: Header Authorization: Bearer <access_token> bei allen geschützten Requests.

Authentifizierung

Nach dem Login senden Sie den JWT im Header Authorization: Bearer <token>. Ohne gültigen Token antworten geschützte Endpoints mit 401 Unauthorized. Registrierung und Login finden Sie unter Registrieren und Anmelden.

Rate Limiting

In Produktion gelten pro Client (IP) Limits pro Minute. Auth-Endpoints sind strenger limitiert (z. B. 10 Requests/Minute). Bei Überschreitung antwortet die API mit 429 Too Many Requests. In der Entwicklungsumgebung sind die Limits gelockert oder deaktiviert.

Fehlercodes

  • 400 Bad Request – Ungültige Anfrage oder Validierungsfehler.
  • 401 Unauthorized – Token fehlt oder ist ungültig.
  • 403 Forbidden – Keine Berechtigung für die Ressource.
  • 404 Not Found – Ressource nicht gefunden.
  • 429 Too Many Requests – Rate Limit überschritten.
  • 500 Internal Server Error – Serverfehler; bitte erneut versuchen.

Webhooks

Webhooks sind derzeit nicht verfügbar. Geplant für spätere Versionen.

API-Changelog

Änderungen und neue Versionen der API finden Sie im API-Changelog.