Mit den folgenden Schritten ist der MCDMS WebService in wenigen Minuten installiert und einsatzbereit.
Voraussetzung ist ein Windows-Server mit installierter .NET Runtime sowie ein gültiges TLS-Zertifikat.
Schritt 1 – Installationspaket entpacken
Entpacken Sie das Installationspaket in ein beliebiges Verzeichnis.
Beispiel:
C:\Temp\MCDMS-WebService
Der Ordner sollte mindestens folgende Dateien enthalten:
MCDMS.WebService.exe
appsettings.json
Installieren.ps1
Deinstallieren.ps1
Schritt 2 – Konfiguration anpassen
Öffnen Sie die Datei
appsettings.json
und passen Sie mindestens folgende Einstellungen an:
| Einstellung | Beispiel |
|---|---|
| API-Key | Eigener geheimer Schlüssel |
| Erlaubte IK | 260820558 |
| BasisPfad | D:\MCDMS\Daten |
| HTTPS-Port | 5001 |
| Zertifikat | MCDMS WebService |
Speichern Sie anschließend die Datei.
Schritt 3 – Installation starten
Öffnen Sie PowerShell als Administrator.
Wechseln Sie in das Installationsverzeichnis.
cd C:\Temp\MCDMS-WebService
Starten Sie anschließend die Installation.
.\Installieren.ps1
Während der Installation werden automatisch
- die Konfiguration geprüft,
- das Zertifikat geprüft,
- die Verzeichnisstruktur erstellt,
- die NTFS-Berechtigungen gesetzt,
- die Firewallregel erstellt,
- der Windows-Dienst installiert und
- der Dienst gestartet.
Nach erfolgreicher Installation erscheint eine entsprechende Erfolgsmeldung.
Schritt 4 – Status prüfen
Prüfen Sie zunächst, ob der Windows-Dienst gestartet wurde.
Öffnen Sie die Windows-Dienstverwaltung oder führen Sie aus:
Get-Service "MCDMS WebService"
Der Status sollte Running lauten.
Anschließend testen Sie den Status-Endpunkt.
https://Servername:5001/api/v1/status
Beispielantwort:
{
"status": "OK",
"version": "1.0.0"
}
Schritt 5 – Testdatei hochladen
Erstellen Sie eine kleine Testdatei.
Beispielsweise:
test.txt
mit folgendem Inhalt:
Hallo MCDMS WebService
Laden Sie die Datei anschließend mit curl hoch.
curl -X POST ^
"https://Servername:5001/api/v1/nachrichten" ^
-H "X-API-KEY: IhrApiKey" ^
-H "X-IK: 260820558" ^
-H "X-Dateiname: test.txt" ^
--data-binary "@test.txt"
Erwartete Antwort:
HTTP/1.1 200 OK
Schritt 6 – Datei kontrollieren
Prüfen Sie das Eingangsverzeichnis.
D:\MCDMS\Daten
│
└── Eingang
└── 260820558
test.txt
test.txt.meta.json
Sind beide Dateien vorhanden, wurde der Upload erfolgreich durchgeführt.
Schritt 7 – Dateiliste abrufen
Prüfen Sie anschließend die REST-API.
curl ^
-H "X-API-KEY: IhrApiKey" ^
-H "X-IK: 260820558" ^
"https://Servername:5001/api/v1/nachrichten/liste"
Der WebService liefert eine Liste aller verfügbaren Dateien zurück.
Schritt 8 – Funktionstest abgeschlossen
Wenn alle vorherigen Schritte erfolgreich durchgeführt wurden,
- ist der Windows-Dienst korrekt installiert,
- funktioniert die HTTPS-Kommunikation,
- ist das Zertifikat gültig,
- arbeitet die Authentifizierung korrekt,
- ist die IK freigegeben,
- können Dateien erfolgreich übertragen werden.
Der MCDMS WebService ist damit betriebsbereit.
Checkliste
| Prüfung | Ergebnis |
|---|---|
| Installation erfolgreich | ☑ |
| Windows-Dienst gestartet | ☑ |
| Status-Endpunkt erreichbar | ☑ |
| HTTPS funktioniert | ☑ |
| API-Key akzeptiert | ☑ |
| IK freigegeben | ☑ |
| Testdatei hochgeladen | ☑ |
| Datei im Eingangsordner vorhanden | ☑ |
| Metadatendatei erzeugt | ☑ |
Nach erfolgreichem Abschluss dieser Checkliste kann der MCDMS WebService produktiv eingesetzt werden.
