Erzeugt aus strukturierten Objektdaten ein fertiges Exposé – als PDF und als
Web-Ansicht – und veröffentlicht es auf den gewünschten Kanälen.
Ein Exposé referenziert immer genau ein Objekt aus der Objektverwaltung.
Freie Exposés ohne Objektbezug gibt es bewusst nicht, damit Pflichtangaben
und Historie an einer Stelle gepflegt werden.
Ablauf
POST /exposesstartet die Generierung. Die Antwort trägtstatus: "in_arbeit".- Sobald das Dokument gesetzt ist, wechselt der Status auf
fertig. Wir empfehlen
das Ereignisexpose.fertiggestelltstatt wiederholter Abfragen. GET /exposes/{exposeId}/pdfliefert das Dokument.POST /exposes/{exposeId}/veroeffentlichenstellt es auf den Kanälen ein.
Pflichtangaben
Vor der Veröffentlichung prüft die API die anzeigepflichtigen Angaben – vor allem
die Kennwerte aus dem Energieausweis und die Provisionsangabe. Fehlt etwas,
antwortet die API mit 422 und code: "pflichtangabe_fehlt".
- Server 1:https://api.maklerportal.example/v1
Produktion
- Server 2:https://sandbox.api.maklerportal.example/v1
Sandbox – Bestand wird nächtlich zurückgesetzt
apiKey (apiKey)
Jeder Aufruf trägt einen API-Schlüssel im Header apikey. Den Schlüssel
erzeugen Sie im Maklerportal unter “Meine Anwendungen”; er wird genau einmal
angezeigt.
An jedem Schlüssel hängen die Scopes, die er nutzen darf. Fehlt einer,
antwortet die API mit 403 und code: "scope_fehlt"; der fehlende Scope
steht in details[].feld.
Nur zu Demonstrationszwecken License