Öffentliche REST API

Navigation:  MLXML Business Integration > Konfiguration > Server >

Öffentliche REST API

Previous pageReturn to chapter overviewNext page

Dieses Kapitel richtet sich an Systemtechniker und Experten

 

In vielen Fällen, z. B. auch für den Betrieb der delight App oder des delight Kunden-Portals, wird eine öffentliche, extern im Internet verfügbare REST-API benötigt. Die Server REST-API von delight ist für diesen Zweck ausgelegt.

 

Beachten Sie dazu bitte folgenden Punkte zum Thema Datenschutz und Sicherheit:

Alle Benutzerkonten müssen mit einem starken Passwort geschützt sein. Dies gilt insbesondere auch für die normalen Benutzerkonten der Mitarbeiter.
 

Prüfen Sie auch allfällige "admin" Benutzer. Wir stellen immer wieder fest, dass das Standard-Passwort nicht geändert wurde oder gar leer ist.
 

Die REST-API muss unbedingt mit einer SSL-Verschlüsselung konfiguriert werden.
 

Sollten Sie API-User mit der Rolle "Systembenutzer" benötigen, schützen Sie diese ebenfalls mit sehr starken Passwörtern und definieren Sie die Erlaubten API Methoden.
 

Deaktivieren Sie den Super-Admin Zugang.
 

Schränken Sie den Kreis der Mitarbeiter, welche externe Kundenzugriffe bearbeiten können, auf eine Minimum ein.

 

 

Überlegungen und Empfehlungen zur Installation:

Verwenden Sie für die API einen hohen TCP/IP Port. z. B. unseren Standard-Port Vorschlag 9090. i. d. R. ist der HTTP/SSL-Port 443 bereits durch eine andere Anwendung besetzt.
 

Verwenden Sie ein offizielles, verifizierbares SSL-Zertifikat. Keine self-signed Zertifikate. Unsere Empfehlung: Verwenden Sie kostenlose Let's Encrypt Zertifikate.
 

Sollten der CRM-Server-Standort keine fix IP-Adresse habe, ist auch ein DynDNS möglich. Wir würden in diesem Fall neben dem DynDNS-Eintrag noch einen weiteren DNS-Eintrag auf Ihrer eigenen Domäne empfehlen.
Bsp. Wenn Ihre Website www.mycompany.ch wäre und der DynDNS des CRM-Server Standorts "mycompany.dyndns.org" wäre, sollten Sie zusätzlich folgenden CNAME-Eintrag erstellen: delightapi.mycompany.ch typ CNAME auf mycompany.dyndns.org
Der API-Endpunkt (der z. B. in die delight App&Portal-Konfiguration übernommen werden muss) wäre in diesem Bsp. dann https://delightapi.mycompany.ch:9090
 
Der Vorteil dieser Lösung: Sollte der CRM-Server irgend wann einmal umziehen (z. B. in eine Cloud oder ein eigenes RZ, anderer DynDNS-Provider weil Hardware wechselt) muss nur der DNS-Eintrag delightapi.mycompany.ch angepasst werden. Eine Neukonfiguration aller externen System welche die API verwenden ist nicht erforderlich.
 

Installieren Sie das SSL-Zertifikat wie hier beschrieben für HTTP.sys, verwenden Sie kein SSL offloading auf der Firewall.
 

Die delight REST-API basiert auf Micosoft's Kernel HTTP.sys. Nach unseren Tests sind damit auf einfachen Servern bereits sehr hohe Durchsätze bis zu 35'000 Requests / Sekunden und mehr möglich. Der Flaschenhals liegt hier oftmals bei der Datenbank. d. h. für Optimierungen ist dort der erste Ansatzpunkt.

 

Im delight App&Portal Hosting ist zusätzlich eine API-Cache Projekt integriert. Sollten Sie ausgewählte Daten öffentlich über eine API zur Verfügung stellen wollen, sollte dies über den API-Cache konfiguriert werden. Der API-Cache ist nicht Teil dieser Dokumentation und wird nur im Rahmen unseres Entwickler-Supports zur Verfügung gestellt bzw. supported.