Dokumente und Medien
Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "DocumentRead" und "DocumentEdit".
Last updated
Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "DocumentRead" und "DocumentEdit".
Last updated
Um Dokumente abrufen oder ändern zu können, müssen die Endpunktberechtigungen "Dokumente lesen" und "Dokumente ändern" aktiviert werden.
Um Medien abrufen oder ändern zu können, müssen die Endpunktberechtigungen "Objektbilder lesen" und "Objektbilder ändern" aktiviert werden
Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.
Da die Dokumente für alle Entitäten hinterlegt werden können, wurde eine zusätzliche Konfiguration eingerichtet, welche es erlaubt, bestimmte Dokumtenobjekte für die API auszuwählen.
Die Einrichtung erfolgt im jeweiligen API-Key im Tab "Dateien".
Die Selektion erfolgt nach einem Blacklist-Whitelist-System. Wenn Sie Entitäten oder Dateiarten ausschließen möchten, selektieren Sie diese mit der "Blacklist"-Auswahl. Wenn Sie Entitäten oder Dateiarten explizit erlauben möchten, verwenden Sie die "Whitelist"-Auswahl.
Im Bereich "Dateien von bestimmten Objekten" können einzelne Entitäten für den Transfer selektiert werden.
Im Bereich "Dateien bestimmter Dateiarten" wählen Sie erlaubte oder unterdrückte Dateiarten aus.
Beide Selektionen werden gleichberechtigt angewendet. Die Selektion "Whitelist" und "Person" im Bereich Objektarten und die Selektion von "Blacklist" und "Allgemeines" im Bereich Dateiart würde die Dokumente aus der Entität "Person" ohne die Dokumente mit der Dateiart "Allgemeines" liefern.
WOWIPORT erlaubt sowohl die Erstellung von Dokumenten im Microsoft Word- und im PDF-Format als auch den Upload von Dateien über eine entsprechende Funktion. Beide Dateiarten sind über die Schnittstelle verfügbar. Zudem können Dateien hochgeladen werden. Die Dateitypen finden Sie in der Liste am unteren Ende des Absatzes.
Für Kunden mit einem WOWIPORT-DMS werden die Dokumente in einem angebundenen, externen System gespeichert. Diese Dokumente sind über unsere Schnittstelle nicht verfügbar.
Erlaubte Dateitypen für den Upload: .pdf, .rtf, .xls, .xlsx, .doc, .docx, .txt, .jpg, .jpeg, .png, .gif, .tiff, .tif, .msg, .heic, .heif, .webp
Kunden, welche das WOWIPORT-DMS nutzen, unterliegen bestimmten Einschränkungen, da es ansonsten zu Konflikten mit dem bereits angebundenen DMS kommen kann.
So ist die Zuordnung einer externen Dokumenten-ID über die schreibenden Endpunkte nicht gestattet. Der Tab "Externes DMS" sowie die dazugehörigen Schnittstellen für die Linkerstellung sind ebenfalls nicht verfügbar.
Die API für Medien folgt ähnlichen Mechanismen wie die API für Dokumente. Die Einrichtung der Dokumentberechtigungen ist hierfür allerdings nicht erforderlich. Lediglich die Endpunktberechtigungen müssen aktiviert werden.
Die Medien können zusätzlich noch Thumbnails für die entsprechenden Bilddateien liefern.
Die Binärdatei wird grundsätzlich mit einer Base64-Encodierung übermittelt. Dies gilt sowohl für die Dokumentenübertragung an uns als auch für das Abrufen von Dateien. Zum Testen der Base64-Encodierung finden Sie kostenlose Tools z. B. im Editor "Notepad++" (beinhaltet ebenfalls einen Rechner für SHA1) oder unter https://www.base64encode.org/. Bitte beachten Sie, dass es sich hierbei nur um Beispiele für kostenlose Testtools handelt.
Um die Unversehrtheit der Dateien nach der Decodierung zu gewährleisten, benötigen wir einen SHA1-Hashkey der nicht-encodeten Binärdaten. Stimmt dieser mit unserer Berechnung überein, gehen wir davon aus, dass die Datei unverändert bei uns eingegangen ist und korrekt gespeichert wurde.
