Öffentliche API v1 & Webhooks
Export & Schnittstellen · 6 Min · Aktualisiert 28. August 2026
Über die öffentliche API v1 lassen sich PlanWerke-Daten anbinden. API-Schlüssel und Webhook-Endpunkte verwaltest du im Entwickler-Bereich (/app/entwickler).
- API-Schlüssel pro Konto/Team erstellen und widerrufen.
- Ein Schlüssel sieht die eigenen Projekte und die Projekte der Teams, in denen du Inhaber:in oder Mitglied bist – dieselbe Zugriffsregel wie in der App.
- Modelle per API hochladen: erst eine signierte Upload-URL anfordern (POST /api/v1/projects/{id}/models/upload-url), die Datei direkt in den Speicher übertragen und dann registrieren (POST /api/v1/projects/{id}/models). Tarif-Limits und Speicher-Kontingent gelten wie beim Upload aus der App.
- Den gespeicherten Planstand eines Plans lesen (GET /api/v1/models/{id}/placements): alle Platzierungen – Melder, Lautsprecher, EMA-Geräte, Sinnbilder, Zonen, Räume, Öffnungen – samt kalibriertem Maßstab. Damit können externe Werkzeuge (z. B. eine Revit- oder Archicad-Anbindung) die Planung übernehmen.
- Webhooks für Ereignisse registrieren – neu auch placements.updated, wenn ein Planstand im Viewer gespeichert wird.
- Details und Endpunkte siehe docs/api-v1.md im Repository.
API-Schlüssel sind wie Passwörter zu behandeln – nicht im Frontend oder in öffentlichen Repos hinterlegen.
Webhook-Zustellung: Der erste Versuch passiert sofort. Schlägt er fehl, wandert die Zustellung in eine dauerhafte Queue und wird im Hintergrund mit wachsendem Abstand wiederholt – erst nach mehreren erfolglosen Versuchen landet sie im Dead-Letter. Die Zustellung ist at-least-once – plane den Empfänger idempotent und dedupliziere über den Header PlanWerke-Event-Id.
War das hilfreich?