Search
K
Exposé erstellen

Exposé erstellen

1.0.0OAS 3.0

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

  1. POST /exposes startet die Generierung. Die Antwort trägt status: "in_arbeit".
  2. Sobald das Dokument gesetzt ist, wechselt der Status auf fertig. Wir empfehlen
    das Ereignis expose.fertiggestellt statt wiederholter Abfragen.
  3. GET /exposes/{exposeId}/pdf liefert das Dokument.
  4. POST /exposes/{exposeId}/veroeffentlichen stellt 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".

API Base URL
  • Server 1:https://api.maklerportal.example/v1

    Produktion

  • Server 2:https://sandbox.api.maklerportal.example/v1

    Sandbox – Bestand wird nächtlich zurückgesetzt

Security
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.

Additional Information
Contact API-Support Objektwerk GmbH (api-support@objektwerk.example)

Nur zu Demonstrationszwecken License

Exposés

Erzeugen, abrufen und veröffentlichen

Exposés auflisten

Liefert die Exposés des Mandanten, optional gefiltert nach Objekt und Status.

get

Query Parameters

objekt_idstring

Nur Exposés zu diesem Objekt.

Example:obj_8f2c1a

statusstring

Lebenszyklus eines Exposés.

Allowed values:in_arbeitfertigveroeffentlichtzurueckgezogenfehlgeschlagen

Example:fertig

limitinteger

Default:25

>= 1<= 100

cursorstring

Cursor aus seite.cursor_naechste der vorigen Antwort.

Response

application/json

Trefferliste

datenarray[object]
Show Child Parameters
seiteobject

Cursor-basierte Paginierung.

Show Child Parameters
get/exposes
 
application/json

Exposé erstellen

Startet die Generierung eines Exposés aus einem Objekt und einer Vorlage.
Die Verarbeitung läuft asynchron; die Antwort trägt zunächst status: "in_arbeit".

post

Body

application/json

ExposeAnlegen

objekt_idstringrequired

Objekt, aus dem das Exposé erzeugt wird.

Example:obj_8f2c1a

vorlage_idstringrequired

Gestaltungsvorlage des Mandanten.

Example:vrl_klassik

sprachestring

Sprache des erzeugten Dokuments.

Allowed values:deen

Default:de

abschnittearray[string]

Inhaltlicher Block des Exposés.

Allowed values:lageausstattungenergiegrundrissprovisionumgebunghistorie

notiz_internstring

Interne Bemerkung, erscheint nicht im Dokument.

<= 500 characters

Example:Eigentümerin wünscht Besichtigungen erst ab dem 1. September.

Response

application/json

Generierung angenommen

Expose

idstring

Example:exp_4d9b2e

objekt_idstring

Example:obj_8f2c1a

vorlage_idstring

Example:vrl_klassik

sprachestring

Example:de

statusstring

Lebenszyklus eines Exposés.

Allowed values:in_arbeitfertigveroeffentlichtzurueckgezogenfehlgeschlagen

Example:fertig

pdf_urlstring(uri)

Nur bei status: fertig gesetzt. Der Link ist 24 Stunden gültig.

Example:https://api.maklerportal.example/v1/exposes/exp_4d9b2e/pdf

seiteninteger

Seitenzahl des erzeugten Dokuments.

Example:6

pflichtangabenobject

Ergebnis der Prüfung anzeigepflichtiger Angaben.

Show Child Parameters
erstellt_amstring(date-time)

Example:2026-08-20T09:41:12Z

fertig_amstring | null(date-time)

Example:2026-08-20T09:41:20Z

post/exposes

Body

{ "objekt_id": "obj_8f2c1a", "vorlage_id": "vrl_klassik", "sprache": "de", "abschnitte": [ "lage", "ausstattung", "energie", "grundriss", "provision" ] }
 
application/json

Exposé abrufen

Liefert Status, Metadaten und den Prüfbericht der Pflichtangaben.

get

Path Parameters

exposeIdstringrequired

Kennung des Exposés.

Example:exp_4d9b2e

Response

application/json

Exposé

Expose

idstring

Example:exp_4d9b2e

objekt_idstring

Example:obj_8f2c1a

vorlage_idstring

Example:vrl_klassik

sprachestring

Example:de

statusstring

Lebenszyklus eines Exposés.

Allowed values:in_arbeitfertigveroeffentlichtzurueckgezogenfehlgeschlagen

Example:fertig

pdf_urlstring(uri)

Nur bei status: fertig gesetzt. Der Link ist 24 Stunden gültig.

Example:https://api.maklerportal.example/v1/exposes/exp_4d9b2e/pdf

seiteninteger

Seitenzahl des erzeugten Dokuments.

Example:6

pflichtangabenobject

Ergebnis der Prüfung anzeigepflichtiger Angaben.

Show Child Parameters
erstellt_amstring(date-time)

Example:2026-08-20T09:41:12Z

fertig_amstring | null(date-time)

Example:2026-08-20T09:41:20Z

get/exposes/{exposeId}
 
application/json