Einleitung

Zur Verwendung der ecoDMS API wird eine freie, gleichzeitige ecoDMS Verbindung benötigt.
Zur Verwendung der ecoDMS API sind sog. API-Connects erforderlich.
1 API-Connect = 1 Upload oder Download über die ecoDMS API
Die Anzahl der zur Verfügung stehenden API-Connects wird beim ersten Up- oder Download in einem neuen Monat zurückgesetzt.
Das genaue Lizenzmodell ist auf der ecoDMS Webseite zu finden.

Hinweis: Sollten zusätzliche API Connects über www.ecodms.de hinzugebucht worden sein, müssen anschließend der ecoDMS Serverdienst sowie der API Dienst (in den ecoDMS Einstellungen) neu gestartet werden.
Bei einer Installation auf einem NAS müssen der ecoDMS Container sowie der API Dienst (in den ecoDMS Einstellungen) neu gestartet werden.

Speziell für Entwickler gibt es diese Schnittstelle.
Die ecoDMS API ermöglicht den Anschluss von beliebigen Drittsystemen wie z.B. CRM-Software, Warenwirtschaftssysteme uvm.
Über die Schnittstelle sind die grundlegenden Funktionen des ecoDMS Servers wie zum Beispiel archivieren, klassifizieren oder herunterladen ansprechbar.
Der Aufruf der einzelnen Funktionen erfolgt über REST Web Services.
So hat jede Funktion eine eindeutige Adresse, die als URL ausgedrückt wird und unter anderem in Internetbrowsern verwendet werden kann.

Bitte beachten Sie:
ecoDMS API REST Service unterstützt nur die UTF-8-Kodierung.
D.h. vor jedem Aufruf jeder REST Funktion muss unbedingt sichergestellt werden, dass der jeweilige HTTP-Request in UTF-8 kodiert ist.

Base URL:

http://hostname:[port]/api/[REST-Command]

Der API REST Service von ecoDMS verwendet die HTTP-Basic-Authentifizierung nach RFC 2617.
Sowie die Verbindung mit einem ecoDMS Archiv erfolgreich hergestellt wurde, müssen die eingegebenen ecoDMS Benutzerdaten (username und password) auf ihre Gültigkeit geprüft werden.
Dies geschieht, indem man das Base64-codierte Authentifizierungsmuster im Header des HTTP-Requests an ecoDMS API REST Service sendet.
Dafür kann die REST-Funktion /test aufgerufen werden.

Verwandte Artikel