Telefon DE: +49-8282-800-400 Telefon AT: +43-7322-370-202 Telefon CH: +41-41-5210-100 info@crmaddon.de

Act! Web API Checklist (self-hosted)

Einige Act! Funktionen benötigen die Act Web API, eine Schnittstelle zum Lesen und Schreiben von Daten der Act! Datenbank.
Funktionen die über die API laufen sind zum Beispiel die Act! Marketing Automation (AMA), Act! Insight und die Pipeline View der Verkaufschancen.
Des Weiteren können darüber auch Webseiten oder andere Anwendungen angebunden werden sofern diese das unterstützen.

 

Anforderungen

Systemanforderungen

  • 1 Maschine mit mindestens Windows 10 (besser Windows Server 2016 oder höher)
  • Eine Platte (60 bis 100 GB, 4 Cores)
  • Über Port 443 von außen erreichbar über http und https (SSL-Zertifikat)- „act(Ihr Domainname)“, sollte eine feste IP besitzen
  • Eine garantierte Ping-Laufzeit von < 4 ms zwischen Act!-Server und Web (web.api)

Erläuterungen

Serveranforderungen
Es wird eine Windows-Maschine mit installiertem und konfiguriertem Act! Premium for Web (kurz APFW) benötigt.
Ihre Act! Datenbank muss im AFPW eingebunden sein und lokal auf dem Server über http://localhost/APFW erreichbar sein.
Eingehende Verbindungen auf dem APFW Port müssen ggf. noch in der Windows-Firewall freigegeben werden.
Stellen Sie des weiteren Sicher dass die Verbindungen nicht von Antivirus Software beeinflusst werden.
Der IIS auf dem APFW Server muss für die APFW Seite ein HTTPS Binding aufweisen.

Netzwerk
Die Act! Web API muss für Funktionen wie die Act! Marketing Automation (kurz AMA) öffentlich erreichbar sein.
Wir empfehlen eine statische öffentliche IP Adresse zu verwenden. Ein DynDNS Service kann verwendet werden wenn keine statische IP Adresse vorhanden ist, der DnyDNS Provider muss jedoch die Verwendung von SSL Zertifikaten ermöglichen.
Hierzu verwendet die AMA standardmäßig das HTTPS Protokoll über Port 443 TCP. Ein anderer Port kann verwendet werden, dies muss anschließend entsprechend im IIS des APFW Servers konfiguriert werden.
Bitte richten Sie eine Portweiterleitung (Destination-NAT) oder einen vergleichbaren Mechanismus (zum Beispiel HTTPS Proxy) ein welcher sicherstellt das Traffic von Ihrer öffentlichen IP Adresse entsprechend an der APFW Server weitergeleitet wird.

FQDN
Die Act! Web API benötigt ein SSL Zertifikat um die Kommunikation zu verschlüsseln. Um ein SSL Zertifikat ausstellen zu lassen wird eine FQDN benötigt (Beispiel: act.meineFirma.de) Falls ein DynDNS Provider verwendet wird so stellt dieser für gewöhnlich die FQDN, ansonsten müssen Sie einen entsprechende FQDN registrieren welche auf Ihren APFW Server verweist.

SSL
Ein SSL Zertifikat für die entsprechende FQND muss auf dem APFW Server im IIS hinterlegt werden. Das SSL Zertifikat muss valide sein und von einer offiziellen Zertifizierungsstelle signiert sein. Self-Signed Zertifikate können nicht verwendet werden.Wenn Ihre Firewall HTTPS Pakete inspizieren kann so sollte dies konfiguriert werden. Der Traffic muss dennoch per HTTPS auf den Act! for Web Server weitergeleitet werden.

DNS Records
Der Versand der Mails ohne Sicherheitsmechanismen ist möglich, kann jedoch dazu führen dass E-Mails vom empfangenden Server abgewiesen werden. SPF und DKIM werden bereits automatisiert durch die AMA gesetzt, falls für Ihre Domain ein DMARC Eintrag verwendet wird muss hier jedoch noch manuell ein DKIM Eintrag konfiguriert werden. Wenn Sie sich dazu entscheiden kein DMARC zu verwenden ist keine weitere Konfiguration des DNS nötig, einige Mailserver wie zum Beispiel die Office 365 Server werden Ihre Mails jedoch als Spam markieren.

Wenn Sie einen DMARK Eintrag verwenden möchten:
Bitte fordern Sie einen DKIM Eintrag an, hierfür können Sie uns einfach eine Mail mit der Bitte um einen DKIM Eintrag und dem entsprechenden Domain-Namen (Beispielsweise meineFirma.de) zukommen lassen.Wir schicken Ihnen einen fertigen Eintrag welchen Sie nur noch bei Ihrem DNS-Registrar hinterlegen müssen.Nachdem Sie den Eintrag bei uns angefordert haben sollten keine Emails mehr über die AMA verschickt werden bis Ihr DNS-Eintrag korrekt konfiguriert ist.

Troubleshooting-Checklist

Die Act! Datenbank ist nicht per Web erreichbar ? Zum testen http://localhost/APFW auf dem Act! for Web Server öffnen.
– IIS Services sind nicht gestartet
– APFW Website ist nicht gestartet
– Die Act! Datenbank wurde nicht in der Website Verwaltung eingebunden
– Es wird der falsche Port verwendet

Die Windows-Firewall ist nicht korrekt konfiguriert. Zum testen https://{apfw-server-ip}/act.web.api  von einem PC im LAN des APFW Servers öffnen.
– Windows Firewall blockiert Kommunikation
Antiviren Tool blockiert Kommunikation
– Es wird der falsche Port verwendet

Act! for Web ist nicht öffentlich erreichbar. Zum testen https://{meine-öffentliche-ip}/act.web.api aufrufen.
– Es wurde keine Portweiterleitung konfiguriert
– Die Konfigurierte Portweiterleitung ist fehlerhaft
– Es wird der falsche Port verwendet

Meine FQDN ist nicht korrekt konfiguriert. Zum testen https://{meine-fqdn}/act.web.api aufrufen
– Die FQDN löst nicht auf Ihre öffentliche IP Adresse auf

Mein Browser zeigt die Seite als „nicht sicher“ an. Zum testen https://{meine-fqdn}/act.web.api aufrufen und im Browser prüfen ob die Seite als „sicher“ angezeigt wird.
– Das SSL Zertifikat wurde nicht hinterlegt
– Das Zertifikat ist abgelaufen
– Es fehlen teile des Zertifikats

 

Falls Sie noch Fragen zur Einrichtung der Act! Web API haben können Sie gerne ein Ticket erstellen oder uns telefonisch unter der 08282 8005050 kontaktieren.