Bilder

Bild hochladen

POST https://api.propstack.de/v1/images

Endpoint zum Hochladen eines Bildes. Ein Bild gehört immer entweder zu einem Projekt oder zu einem Objekt. Die Bilder-Parameter müssen um ein image Objekt umschlossen werden.

Request Body

Name	Type	Description
photo	string	base64 encoded String für das Bild
imageable_id	integer	ID des Objektes/Projektes
imageable_type	string	Entweder "Property" oder "Project", je nachdem ob das Bild an ein Objekt oder Projekt angehangen wird.
is_private	boolean	Wenn false => Bild auf Portale anzeigen. Bei true => Bild wird nicht zu Portalen übertragen
title	string	Bildbeschreibung. Wird auch als Dateiname in der URL verwendet

201 Bild erfolgreich erstellt. ID des Bildes wird zurückgegeben.

{
  "ok": true,
  "id": 38202
}

Beispiel Payload

{
  "image": {
    "imageable_id": 12,
    "imageable_type": "Property",
    "photo": "data:image/png;base64,...",
    "title": "Ausblick"
  }
}

Bild bearbeiten

PUT https://api.propstack.de/v1/images/{id}

Request Body

Name	Type	Description
title	String	Bildbeschreibung
is_private	String	Wenn false => Bild auf Portale anzeigen. Bei true => Bild wird nicht zu Portalen übertragen

Bild-Beschreibung mehrsprachig bearbeiten

Die Bildbeschreibung ist ein mehrsprachiges Feld, d.h. man kann es in verschiedenen Sprachen befüllen. Über die API geht das, indem man das Feld title_[locale] bedient. [locale] muss mit der jeweiligen Sprache ersetzt werden. Ein Beispiel-Payload um die deutsche und englische Version gleichzeitig zu setzen:

{
  "image": {
    "title_de": "Ausblick",
    "title_en": "View"
  }
}