API-Dokumentation (Swagger)

Hier findest du die vollständige interaktive API-Dokumentation basierend auf der OpenAPI 3.0 Spezifikation.

Direkter Download

Du kannst die OpenAPI-Spezifikation auch direkt herunterladen:

• OpenAPI 3.0 YAML-Datei herunterladen

Alternative Dokumentation

Neben dieser interaktiven Swagger-Dokumentation findest du auch:

• API-Übersicht - Einführung und Quick Start
• Authentifizierung - Token-Verwaltung
• Endpoints - Detaillierte Endpoint-Dokumentation
• Beispiele - Code-Beispiele in verschiedenen Sprachen
• Fehlerbehandlung - Error-Codes und Retry-Strategien

Postman Collection

Für Postman-Nutzer:innen kannst du die OpenAPI-Spezifikation direkt in Postman importieren:

1. Öffne Postman
2. Klicke auf "Import"
3. Wähle "Link" und füge diese URL ein: https://foerdermittelkompass.reflecta.org/api/openapi.yaml
4. Klicke auf "Continue" und dann "Import"

Postman erstellt automatisch eine Collection mit allen Endpoints.