Schnittstelle einrichten

Die Einrichtung der Schnittstelle geschieht in mehreren Registerkarten. Dabei geht es im Wesentlichen darum, den Dienst zu starten und die Zugangsdaten zu hinterlegen, mit denen Daten in einer bestimmten Datenbank verändert werden dürfen.

• Die Schnittstelle läuft als lokaler Dienst »cobra CXM WEB CONNECT Service«.

»Status«

Sichere Verbindung einrichten

• Stellen Sie sicher, dass die Portnummer und die sichere Verbindung in Ihrer Firewall eingerichtet sind.
• Richten Sie das SSL-Zertifikat - z.B. Windows-PFX-Zertifikat - ein und binden Sie es auf den Port. Kontaktieren Sie Ihre IT, sie wird Ihnen das benötigte Zerftifikat zur Verfügung stellen.
• Die Bindung des SSL-Zertifikates auf den Port kann über die Kommandozeile (CMD) erfolgen:

1. Starten Sie CMD als Administrator.
2. Erteilen Sie den Befehl »Netsh«.
3. Erteilen Sie den Befehl »http«.
4. Erteilen Sie den Befehl »add sslcert ipport=IP-Adresse:Port certhash=Fingerprint addid=GUID«.

Ersetzen Sie »IP-Adresse:Port«, »Fingerprint« und »GUID« mit Ihren Daten.

certhash (Fingerprint)

Den »certhash« bzw. »Fingerprint« erhalten Sie von Ihrem Administrator, oder sie können diese Eigenschaft manuell aus dem Zertifikat per Kontextmenü auslesen.

• Klicken Sie das Zertifikat doppelt an.
• Wechseln Sie in den Reiter »Details«.

Dort finden Sie das Feld »Fingerabdruck« mit den benötigten Daten.

appid (GUID)

Die »appid« bzw. »GUID« kann hier erstellt werden.

Beispiel:

netsh http add sslcert ipport=172.16.1.32:30001 certhash=43953a5f065fb433c6b620dddcf37cb358ebbede appid={91291103-8638-4b7c-a3ab-649450d4c947}

Das SSL-Zertifikat hinterlegen

Es gibt zwei Möglichkeiten das Zertifikat in CXM WEB CONNECT zu hinterlegen:

1. Das Zertifikat auf Dateiebene hinterlegen

• Exportieren Sie das Zertifikat aus dem Zertifikatsspeicher in den gewünschten Ablageort.
• Passen Sie die CXM Konfigurations-Datei an:

C:\Program Files\cobra\CXM WEB CONNECT\WebApi\appsettings.json

• Fügen Sie den Eintag für das Zertifikat und dessen Ablageort und Passwort hinzu.

Beispiel vor der Änderung:

{
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft": "Warning",
            "Microsoft.Hosting.Lifetime": "Information"
        }
    },
    "AllowedHosts": "*"
}

Beispiel nach der Änderung:

{
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft": "Warning",
            "Microsoft.Hosting.Lifetime": "Information"
        }
    },
    "AllowedHosts": "*",
"Kestrel": {
    "Certificates": {
        "Default": {
            "Path": "C:\\Program Files (x86)\\cobra\\WebConnectorServer2020\\Zertifikat\\Zertifikat.pfx",
               "Password": "cobra2021!"
         }}}
}

2. Das Zertifikat aus dem Zertifikatspeicher binden

Sie belassen das Zertifikat im Zertifikatspeicher.

• Passen Sie die CXM Konfigurations-Datei an.

C:\Program Files\cobra\CXM WEB CONNECT\WebApi\appsettings.json

• Fügen Sie den Eintrag mit dem Verweis auf den Zertifikatsspeicher hinzu.

Beispiel vor der Änderung:

{
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft": "Warning",
            "Microsoft.Hosting.Lifetime": "Information"
        }
    },
    "AllowedHosts": "*"
}

Beispiel nach der Änderung:

{
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft": "Warning",
            "Microsoft.Hosting.Lifetime": "Information"
        }
    },
    "AllowedHosts": "*",
"Kestrel": {
    "Certificates": {
        "Default": {
                    "Subject": "localhost",
                     "Store": "Root"
        }}}
}

»Datenbanken«

Hier geben Sie an, für welche cobra Datenbank der Zugriff eingerichtet werden soll.

• Tragen Sie die cobra Zugangsdaten ein. Dies geschieht getrennt für die Adressdaten-, die Benutzer- und die Systemdatenbank.

»Endpunkte«

Als Endpunkte geben Sie an, auf welche Daten innerhalb der zuvor ausgewählten Datenbank der Benutzer per REST-API zugreifen darf. Es stehen Ihnen die folgenden Tabellen der Datenbank zur Verfügung:

• Adressen
• Kontakte
• Zusatz- und Unterdaten
• freie Tabellen

Übertragen Sie beispielsweise Adressdaten und Kontaktdaten über ein Formular, so wären dies zwei Endpunkte, da die Daten in zwei unterschiedliche Tabellen geschrieben werden, die Adresstabelle und die Kontakttabelle.

Zum Einrichten und Arbeiten mit Endpunkten, siehe REST-API verweden.

»Sicherheit«

Hier richten Sie die API-Keys und die Authentifizierung ein.

API-Keys

Zur Ansteuerung der gesetzten REST-Endpunkte benötigen Sie mindestens einen API-Key.

• Klicken Sie auf »Hinzufügen«, um einen neuen API-Key zu erstellen.
• Vergeben Sie einen relevanten Namen für den erstellten API-Key.
• Aktivieren/Deaktivieren Sie den erstellten API-Key via der Checkbox.
• Legen Sie die Zugriffsweite des API-Keys fest. Klicken Sie hierzu in der Spalte »Endpunkte« auf das »...«-Symbol.

Sie können den Zugriff auf alle Endpunkte erlauben oder den Zugriff auf ausgewählte Endpunkte beschränken.

• Löschen Sie einen API-Key, indem Sie diesen auswählen und auf die Schaltfläche »Löschen« klicken.

Authentifizierung

Wählen Sie hier die gewüschte Art der Authentifizierung aus.

Abschluss

Haben Sie alle Schritte der Konfiguration durchlaufen, bestätigen Sie mit »Übernehmen« bzw. »OK«.

• Starten Sie den Dienst jetzt neu, damit die geänderten Einstellungen gültig werden.