API-Schnittstelle (Web)
Die BauMaster App bietet eine Token-authentifizierte REST API an. Bitte beachten Sie, dass die API-Dokumentation wie üblich in Englisch ist.
In der aktuellen Fassung (1.0.1) stehen Endpunkte für folgende Funktionen zur Verfügung:
- Projekte erstellen
- Firmen und Kontakte
- Anhänge (Bilder und Dateien) und PDF-Dokumente (PDF-Protokolle und Berichte)
Für die Einrichtung eines API-Keys ist der Weg über den Support verpflichtend, weil dafür der Entwicklermodus aktiviert werden muss: Schreiben Sie an support@bau-master.com.
BauMaster API
Dies ist die Spezifikation der öffentlichen API von BauMaster.
Der Zugriff auf die Endpunkte setzt ein ApplicationToken voraus, das im BauMaster-Client erzeugt wird. Der API-Zugriff (Entwicklermodus) muss zuvor über den BauMaster-Support freigeschaltet werden.
Das ApplicationToken lässt sich im BauMaster-Client widerrufen.
Die API erreichen Sie unter: https://api.bau-master.at
Den BauMaster-Support erreichen Sie unter: support@bau-master.com
Weitere Informationen finden Sie unter: https://bau-master.com
Wenn Sie Zugang zu einer Staging-Umgebung benötigen, schreiben Sie an die genannte Adresse.
Bereiche
Project: Zugriff auf Projekte
CompanyProfile: Zugriff auf Firmen und Profile (Kontakte)
Profile: Zugriff auf Profile (Kontakte) von Firmen
ProjectRoom: Zugriff auf „Pläne & Dokumente” – in dieser Dokumentation „project room” genannt – inklusive Anhängen, PDF-Protokollen, hochgeladenen Dateien und mehr
Endpunkte
Die vollständige Endpunktreferenz (Project, CompanyProfile, Profile, ProjectRoom, inklusive Request-Headern, Antwortcodes und Beispiel-Payloads) wird als lebende Spezifikation gepflegt.
Wo ist die vollständige Referenz? Die Endpunkt-Spezifikation ist in Englisch verfasst und sprachneutral, deshalb wird sie nicht doppelt gepflegt. Sie ist beim BauMaster-Support auf Anfrage unter support@bau-master.com erhältlich.
FAQ
Wie bekomme ich einen API-Key?
Nur über den Support, weil zuvor der Entwicklermodus aktiviert werden muss. Schreiben Sie an support@bau-master.com.
In welcher Sprache ist die API-Dokumentation?
In Englisch.
Kann ich das Token widerrufen?
Ja, das ApplicationToken lässt sich im BauMaster-Client widerrufen.
Gibt es eine Staging-Umgebung?
Ja, auf Anfrage über den Support.
Stichwörter: API-Schnittstelle