---
title: "Überblick"
description: "Diese API verwandelt einen Objektdatensatz in ein fertiges, veröffentlichungsfähiges Exposé – als PDF und als Web-Ansicht."
url: "https://maklerportal.apim.eu/apis/expose-erstellen/docs/uebersicht"
image: "https://maklerportal.apim.eu/_og/d/c_Ocean.takumi,title_~w5xiZXJibGljaw,description_~RGllc2UgQVBJIHZlcndhbmRlbHQgZWluZW4gT2JqZWt0ZGF0ZW5zYXR6IGluIGVpbiBmZXJ0aWdlcywgdmVyw7ZmZmVudGxpY2h1bmdzZsOkaGlnZXMgRXhwb3PDqSDigJMgYWxzIFBERiB1bmQgYWxzIFdlYi1BbnNpY2h0Lg,props_eyJ0aGVtZSI6eyJtb2RlIjoiZGFyayIsImNvbG9ycyI6eyJwcmltYXJ5IjoiI0Q0QTI0QyJ9fX0,p_Ii9hcGlzL2V4cG9zZS1lcnN0ZWxsZW4vZG9jcy91ZWJlcnNpY2h0Ig,s_JYjU0G-Qkdbxu-qg.png"
---

# Überblick

Diese API verwandelt einen Objektdatensatz in ein fertiges, veröffentlichungsfähiges Exposé – als PDF und als Web-Ansicht.

## [Wofür sie gedacht ist](#wofür-sie-gedacht-ist)

-   Exposés automatisch erzeugen, sobald ein Objekt vollständig erfasst ist
-   Mehrsprachige Fassungen desselben Objekts ausliefern
-   Vor der Veröffentlichung prüfen lassen, ob alle anzeigepflichtigen Angaben vorliegen
-   Bestehende Exposés gezielt von einzelnen Kanälen zurückziehen

## [Wofür sie nicht gedacht ist](#wofür-sie-nicht-gedacht-ist)

Die API pflegt keine Objektdaten. Titel, Preis, Flächen und Energieausweis gehören in die **Objektverwaltung**; das Exposé liest sie von dort. Damit gibt es genau eine Wahrheit, und eine Preisänderung muss nicht an mehreren Stellen nachgezogen werden.

## [Zustände eines Exposés](#zustände-eines-exposés)

| Status          | Bedeutung                                                      |
| :-------------- | :------------------------------------------------------------- |
| in_arbeit       | Generierung läuft, üblicherweise 2–10 Sekunden                 |
| fertig          | PDF steht bereit, noch nicht veröffentlicht                    |
| veroeffentlicht | Auf mindestens einem Kanal live                                |
| zurueckgezogen  | Von allen Kanälen genommen, Dokument bleibt abrufbar           |
| fehlgeschlagen  | Generierung abgebrochen, Grund steht in pflichtangaben.fehlend |

Ein einmal erzeugtes Exposé wird nie nachträglich verändert. Ändert sich das Objekt, erzeugen Sie ein neues – so bleibt nachvollziehbar, welches Dokument einem Interessenten zu welchem Zeitpunkt vorlag.

## [Benötigte Scopes](#benötigte-scopes)

| Aufruf                                         | Scope             |
| :--------------------------------------------- | :---------------- |
| Exposés und Vorlagen lesen, PDF laden          | exposes:lesen     |
| Exposé erzeugen, veröffentlichen, zurückziehen | exposes:schreiben |