Bevor diese Konfiguration eingerichtet werden kann, muss die grundlegende Installation der Handyman API vorhanden sein. Diese Seite finden Sie hier: Handyman API Installation Guide
Die Handyman API ist ein Dienst, der externen Programmen und/oder Diensten Zugriff auf die Daten von Handyman gibt.
Einige Beispiele könnten sein:
- Integrationen mit ERP-Systemen
- Extraktion von Daten zur Verarbeitung in externen Systemen
- Handyman Office-Berichte auf mobilen Geräten
- Einrichtung und Konfiguration des Handyman Portals
Damit die Handyman API im Internet verfügbar gemacht werden kann, muss sie mit sicherer Kommunikation zwischen den Parteien eingerichtet werden. In der Praxis bedeutet dies, dass der API-Dienst folgende Schritte durchlaufen muss:
-
Zertifikat für die Umgebung
Die Umgebung muss ein Zertifikat erhalten, das Sie für https-Datenverkehr verwenden können. Dieses muss nach Standardverfahren installiert werden. -
Öffnen des Datenverkehrs vom Internet zum Server
Hier müssen der IT-Verantwortliche des Kunden oder der Lieferant zwei vorbereitende Aufgaben erledigen:
a. Verbinden Sie einen Namen in der Domain, der auf eine externe IP-Adresse verweist, über die der Kunde verfügt. Ein Beispiel wäre: hmapi.customer.com, dies ist jedoch vollkommen optional.
b. Öffnen Sie den Datenverkehr für https (TCP 443) aus dem Internet und leiten Sie den Datenverkehr an den Server weiter, auf dem der Handyman API-Dienst laufen soll -
Zertifikat mit Handyman API verknüpfen
Dies geschieht, indem Sie den Fingerabdruck (Thumbprint) des auf dem Server installierten Zertifikats über die MMC (Microsoft Management Console) suchen und diesen mit der GUID der Handyman API verbinden.
a. Starten Sie MMC über "Ausführen"
b. Fügen Sie die Ansicht für Zertifikate hinzu
c. Suchen Sie das installierte Zertifikat und kopieren Sie den Fingerabdruck
d. Fingerabdrücke können beim Kopieren ungültige Zeichen enthalten. Fügen Sie ihn in einen Texteditor ein und entfernen Sie alle Zeichen, sodass nur Zahlen und Buchstaben übrig bleiben.
e. Führen Sie Folgendes in einer Eingabeaufforderung aus (muss als Administrator ausgeführt werden). Die X müssen durch den zuvor kopierten Fingerabdruck ersetzt werden.
"netsh http add sslcert ipport=0.0.0.0:443 appid={C504379D-4D9A-436B-82B0-858FE26AB997} certhash=XXXXXXXXXXXXXXXXXXXXXXXX" -
Konfiguration des Handyman Control Center
Damit die Handyman API auf https antwortet, muss folgende Konfiguration geändert werden (Beispiel im Bild unten):
a. URL zur Handyman API: Diese muss "https://" und die lokale IP-Adresse enthalten
b. Optionale externe Adresse: Hier die externe URL eingeben
c. URL zum GSG Identity Management Server: Nur Verweis auf GSG Handymans IDM (https://idm.gsgroup.io) -
Dienst neu starten und testen
Starten Sie auf einem anderen, mit dem Internet verbundenen Gerät einen Browser und rufen Sie folgende Adresse auf: https://hmapi.customer.com/swagger
Wenn die Website im Browser angezeigt wird, sind Konfiguration und Einrichtung korrekt.