File Sharing

Neben der API-Dokumentation ermöglicht das Developer Portal Anbietern von API-Produkten auch das Teilen wichtiger Dokumente mit Kunden. Diese Dokumente können Verträge, Rechnungen, Berichte u.v.m. umfassen und können im Zusammenhang mit einer App oder einer bestimmten API geteilt werden.

Darüber hinaus bietet das Developer Portal Automatisierungsfunktionen, die dazu beitragen können, Prozesse im Zusammenhang mit dem Teilen und Verwalten von Dokumenten zu optimieren. Zum Beispiel können technische Benutzer Workflows erstellen, die automatisch Berichte oder Rechnungen generieren und an Abnehmer verteilen.

Files & Folder

Über das Developer Portal können Anbieter und Kunden Dokumente austauschen. Vorbedingung hierfür ist eine gegenseite Beziehung über eine App.

Default Folder Struktur

*File-Exchange

Der Admin eines Anbieters hat die Möglichkeit innerhalb der oben genannten Default Folder-Struktur weitere Ordner zu erstellen und in diesen Ordner Dateien abzulegen. Auch der Admin des Kunden hat die Möglichkeit Dateien in die vorgegebene Ordnerstruktur abzulegen, diese Dateien werden dann als "Kunden Upload" gekennzeichnet.

info

Es gibt Restriktionen, welche Dateitypen hochgeladen werden dürfen!

*Documentation-Files

Der Admin eines Anbieters hat die Möglichkeit Dateien direkt an der API zu hinterlegen. Diese Dateien dienen zum einen zur Dokumentation der API und zum anderen für weitere Ressourcen zum Download.

Dokumente	Beschreibung
API-Explorer	Open-API-Format (SwaggerUI). Stellt die hochgeladene Open-API-Datei in einer Standard-Swagger-UI dar.
Readme	Dateiformat Markdown. Diese Datei wird direkt in der API-View dargestellt. Alle H1 Überschriften dienen als Navigation.
Sonstiges	Alle weiteren Dateien, welche für die Dokumentation der API notwendig sind.

info

Es gibt Restriktionen, welche Dateitypen hochgeladen werden dürfen!