Ein Benutzer, der sich mit der InterAction API verbindet, muss ein gültiger InterAction-Benutzer sein. Dies gilt unabhängig davon, welche Art von Anwendung (InterAction für Microsoft® Outlook® oder eine eigene Anwendung) der Benutzer verwendet.
Um dies zu gewährleisten, authentifiziert die REST API Benutzer jedes Mal, wenn sie eine Verbindung herstellen möchten. Sie können die REST API so konfigurieren, dass sie diese Authentifizierung auf verschiedene Arten durchführt – je nach Umgebung und Sicherheitsanforderungen Ihrer Organisation.
Das Hauptziel der Authentifizierungseinstellungen für die REST API ist sicherzustellen, dass nur gültige Benutzer auf die InterAction-Daten zugreifen können und dass diese Benutzer nur die Daten sehen und ändern können, für die sie in InterAction Zugriffsrechte haben. Außerdem müssen alle Verbindungen sicher sein – sowohl zwischen den Arbeitsplätzen der Benutzer und der REST API als auch zwischen Servern in Ihrem Netzwerk.
Beachten Sie, dass Sie neben der Konfiguration Ihrer Optionen im InterAction Administrator möglicherweise auch den Internet Information Services (IIS) mit bestimmten Einstellungen konfigurieren müssen, damit die REST API korrekt funktioniert. Darüber hinaus können Webanwendungen je nach gewählter Option zusätzliche Einstellungen erfordern.
- Informationen zu API-Authentifizierungsmodi
- InterAction-Authentifizierung
- Integrierte Windows-Authentifizierung
- Verwendung eines Hash-basierten Message Authentication Code für Verschlüsselung und Sicherheit (HMAC)
- Authentifizierungsmodus auswählen
- HMAC-Schlüssel konfigurieren
- IIS-Einstellungen für das REST API Virtual Directory überprüfen und aktualisieren
- IIS-Einstellungen für Webanwendungen, die die API aufrufen, überprüfen und aktualisieren
- Verwendung von Windows-Integration und InterAction-Authentifizierung sowie Verbindung von nicht vertrauenswürdigen Domänen
- Sichere Kommunikation konfigurieren (HTTP/HTTPS)
Informationen zu API-Authentifizierungsmodi
Der Authentifizierungsmodus bestimmt, wie die API den Benutzer identifiziert, der versucht, sich mit InterAction zu verbinden. Es stehen zwei Haupttypen der API-Authentifizierung zur Verfügung:
InterAction-Authentifizierung. In diesem Fall muss die Anwendung den InterAction-Benutzernamen und das Passwort des Benutzers abfragen. Siehe InterAction-Authentifizierung.
Integrierte Windows-Authentifizierung. Bei diesem Typ versucht die API, den Windows-Benutzernamen des Benutzers mit einem InterAction-Benutzernamen abzugleichen. So kann sich der Benutzer mit InterAction verbinden, ohne Benutzername und Passwort eingeben zu müssen.
Siehe „Integrierte Windows-Authentifizierung“.
Sie wählen den Authentifizierungsmodus im Dialogfeld „API-Konfiguration – Authentifizierung“ aus.
Auswahl eines Authentifizierungsmodus
[A] Auswahl des Authentifizierungsmodus.
Der von Ihnen gewählte Modus kann bestimmte IIS-Einstellungen erfordern, damit er korrekt funktioniert. Details finden Sie im jeweiligen Thema zum Modus.
Für jeden Authentifizierungsmodus können Sie entweder das HTTP- oder HTTPS-Protokoll für die Kommunikation verwenden. Die API verwendet die Einstellungen, die Sie in IIS festlegen. Weitere Informationen finden Sie unter Sichere Kommunikation konfigurieren (HTTP/HTTPS).
InterAction-Authentifizierung
Die InterAction-Authentifizierung ist der einfachste Authentifizierungsmodus zur Konfiguration. Wenn Sie diese Option wählen, müssen Benutzer bei jeder Verbindung zur REST API ihren InterAction-Benutzernamen und ihr Passwort angeben.
Beispielsweise müsste eine eigene Anwendung, die die InterAction API verwendet, den InterAction-Benutzernamen und das Passwort des Benutzers abfragen und diese Informationen weitergeben.
Der Modus „InterAction-Authentifizierung“ schützt das InterAction-Passwort des Benutzers beim Senden an die REST API durch folgende Maßnahmen:
- Das Passwort wird mit einem öffentlichen/privaten Schlüsselpaar verschlüsselt.
- Ein Hash-basierter Message Authentication Code (HMAC) wird verwendet, um die an die REST API gesendete Nachricht zu signieren und sicherzustellen, dass sie während der Übertragung über Server und Netzwerk nicht manipuliert wurde.
Daher müssen Sie bei Auswahl dieses Authentifizierungsmodus zwei Schlüssel konfigurieren:
- Das öffentliche/private Schlüsselpaar zur Passwortverschlüsselung
- Den HMAC-Schlüssel
Details finden Sie unter Verwendung eines Hash-basierten Message Authentication Code für Verschlüsselung und Sicherheit (HMAC) und HMAC-Schlüssel konfigurieren.
Die InterAction-Authentifizierung ist der Standardmodus, der bei der Installation der REST API ausgewählt ist. Wenn es in Ihrer Organisation akzeptabel ist, dass Benutzer ihren InterAction-Benutzernamen und ihr Passwort eingeben, müssen Sie nach der Installation der REST API nur die Standardeinstellungen überprüfen und die HMAC-Schlüssel konfigurieren.
Integrierte Windows-Authentifizierung
Mit der integrierten Windows-Authentifizierung können Ihre Benutzer den Anmeldedialog überspringen. In diesem Fall verwendet die REST API die Windows-Anmeldedaten des Benutzers zur Authentifizierung. Das ist für die meisten Organisationen oft bequemer.
Um diese Methode zu verwenden, müssen die Windows-Benutzernamen Ihrer Benutzer mit ihren InterAction-Benutzernamen übereinstimmen. Dieser Authentifizierungsmodus kann je nach Umgebung auch mehr Konfiguration erfordern.
Webanwendungen und Windows-Authentifizierung
Für eine Webanwendung benötigen Sie bei Verwendung der Windows-Authentifizierung einige zusätzliche Einstellungen:
-
Stellen Sie ein zu vertrauendes Windows-Dienstkonto bereit. Dies ist das Windows-Konto, unter dem die Webanwendung ausgeführt wird.
Sie konfigurieren dies für die API und aktualisieren auch die IIS-Einstellungen für die Webanwendung. Weitere Informationen zu den Einstellungen für Webanwendungen finden Sie unter IIS-Einstellungen für Webanwendungen, die die API aufrufen, überprüfen und aktualisieren.
-
Konfigurieren Sie den Hash-basierten Message Authentication Code (HMAC) für die Übermittlung der Benutzeranmeldedaten. So wird sichergestellt, dass die Informationen sicher übermittelt werden und während der Übertragung über Server und Netzwerk nicht manipuliert werden können.
Details finden Sie unter Verwendung eines Hash-basierten Message Authentication Code für Verschlüsselung und Sicherheit (HMAC) und HMAC-Schlüssel konfigurieren.
Windows-Anwendungen und Windows-Authentifizierung
Windows-Anwendungen, die die API verwenden, benötigen in der Regel kein zu vertrauendes Windows-Dienstkonto. Sie benötigen auch keine HMAC-Einstellungen.
Verwendung eines Hash-basierten Message Authentication Code für Verschlüsselung und Sicherheit (HMAC)
Ein Hash-basierter Message Authentication Code (HMAC) bietet eine Möglichkeit, sowohl die Sicherheit als auch die Datenintegrität einer über ein Netzwerk gesendeten Nachricht zu gewährleisten. Diese Methode zur Verschlüsselung einer Nachricht basiert auf einem geheimen Schlüssel, der sowohl dem Absender als auch dem Empfänger der Nachricht bekannt ist.
Im Zusammenhang mit InterAction und der REST API ist der Absender der Nachricht die Anwendung, die die API aufruft, zum Beispiel eine eigene Anwendung, die die API verwendet. Der Empfänger der Nachricht ist die auf Ihrem Server installierte REST API.
Die Verwendung von HMAC für die Authentifizierung stellt sicher, dass die über das Netzwerk gesendeten InterAction-Anmeldedaten sicher bleiben. Der Absender berechnet einen Hashwert für die Anmeldeinformationen und sendet sowohl die Anmeldeinformationen als auch den HMAC als eine einzige Nachricht. Die REST API berechnet den Hashwert der empfangenen Nachricht erneut und prüft, ob der berechnete Hashwert mit dem übertragenen Hashwert übereinstimmt. Stimmen sie nicht überein, wurde die Nachricht während der Übertragung verändert.
In diesem Fall ist es tatsächlich die .NET API, die den Hashwert erstellt und an die REST API sendet.
Wann muss ich die HMAC-Schlüssel konfigurieren?
Sie müssen die HMAC-Schlüssel in folgenden Szenarien konfigurieren:
-
Bei Verwendung der InterAction-Authentifizierung. Dies stellt die Sicherheit der InterAction-Kontoinformationen sicher. Das Passwort des Benutzers wird immer verschlüsselt, bevor es zur Authentifizierung an die REST API gesendet wird.
Weitere Informationen zu diesem Authentifizierungsmodus finden Sie unter InterAction-Authentifizierung.
-
Bei Verwendung der integrierten Windows-Authentifizierung und Angabe eines zu vertrauenden Windows-Dienstkontos. Dies wird normalerweise für Webanwendungen (wie SharePoint) verwendet, die auf einem anderen Server als die REST API installiert sind.
Weitere Informationen zu diesem Authentifizierungsmodus finden Sie unter Integrierte Windows-Authentifizierung.
-
Bei Verwendung der Funktion Task Notification. In diesem Fall müssen Sie:
- Integrierte Windows-Authentifizierung verwenden.
- Das zu vertrauende Windows-Dienstkonto festlegen.
- Die HMAC-Schlüssel konfigurieren.
Dies stellt die Sicherheit der Aufgabeninformationen sicher.
HMAC basiert auf HMAC-Schlüsseln, um Informationen zu verschlüsseln und sicherzustellen, dass die Nachricht, die die REST API von der Anwendung erhält, während der Übertragung nicht verändert wurde. Wenn Sie HMAC mit Ihrem Authentifizierungsmodus verwenden, müssen Sie diese Schlüssel konfigurieren; siehe HMAC-Schlüssel konfigurieren.
Authentifizierungsmodus auswählen
Sie legen den Authentifizierungsmodus im InterAction Administrator fest.
- Öffnen Sie in der Hauptübersicht im InterAction Administrator per Doppelklick die InterAction API-Konfiguration.
- Wählen Sie Authentifizierung.
- Wählen Sie unter API-Authentifizierungsmodus den gewünschten Modus aus.
- Weitere Informationen zu den möglichen Modi finden Sie unter InterAction-Authentifizierung und Integrierte Windows-Authentifizierung.
- Beachten Sie, dass Sie sowohl InterAction-Authentifizierung als auch integrierte Windows-Authentifizierung auswählen können.
-
Wenn Sie Integrierte Windows-Authentifizierung ausgewählt und das zu vertrauende Windows-Dienstkonto aktiviert haben, geben Sie das Konto oder die Konten in das Textfeld ein. Dies ist normalerweise das Konto, unter dem Ihre Webanwendung läuft (in IIS ist dies das für den Anwendungspool konfigurierte Konto).
Weitere Informationen finden Sie unter Webanwendungsidentität und Windows-Authentifizierung.
-
Wenn der von Ihnen gewählte Modus HMAC erfordert, richten Sie Ihre HMAC-Schlüssel wie unter HMAC-Schlüssel konfigurieren beschrieben ein.
Wenn HMAC für Ihren Authentifizierungsmodus erforderlich ist, ist die Schaltfläche „HMAC-Einstellungen“ aktiviert. Wenn HMAC nicht erforderlich ist, ist die Schaltfläche deaktiviert.
- Wählen Sie OK, um das Dialogfeld zu schließen und Ihre Änderungen zu speichern.
-
Überprüfen Sie Ihre IIS-Konfiguration, um sicherzustellen, dass sie für diese Authentifizierungsmethode korrekt eingestellt ist.
Siehe IIS-Einstellungen für das REST API Virtual Directory überprüfen und aktualisieren.
HMAC-Schlüssel konfigurieren
HMAC basiert auf Schlüsseln, die zur Verschlüsselung von Informationen und zur Sicherstellung verwendet werden, dass die Nachricht, die die REST API von der Anwendung erhält, während der Übertragung nicht verändert wurde. Je nach gewählten Authentifizierungseinstellungen müssen Sie diese Schlüssel möglicherweise generieren.
Sie verwenden das Dialogfeld „HMAC-Einstellungen“, um die Schlüssel zu generieren. Diese werden in der InterAction-Datenbank gespeichert. Es gibt zwei separate Elemente, die Sie möglicherweise generieren müssen:
- Das Schlüsselpaar zur Passwortverschlüsselung
- Den HMAC-Schlüssel
Das Schlüsselpaar zur Passwortverschlüsselung
Das Schlüsselpaar zur Passwortverschlüsselung besteht aus zwei Schlüsseln. Einer ist ein öffentlicher Schlüssel, den Anwendungen, die die REST API aufrufen, verwenden, um das InterAction-Passwort des Benutzers vor dem Senden an den Server zu verschlüsseln. Der andere ist ein privater Schlüssel, der in der InterAction-Datenbank gespeichert ist. Die REST API verwendet diesen, um das InterAction-Passwort zu entschlüsseln.
Beachten Sie, dass das Schlüsselpaar zur Passwortverschlüsselung nur erforderlich ist, wenn Sie die InterAction-Authentifizierung verwenden. Die Option Integrierte Windows-Authentifizierung benötigt das Schlüsselpaar nicht, da das InterAction-Passwort des Benutzers nicht an die REST API gesendet werden muss.
Es ist möglich, sowohl InterAction-Authentifizierung als auch integrierte Windows-Authentifizierung auszuwählen. In diesem Fall benötigen Sie das Schlüsselpaar zur Passwortverschlüsselung, da Sie die InterAction-Authentifizierung verwenden.
So erstellen Sie das Schlüsselpaar zur Passwortverschlüsselung:
- Öffnen Sie in der Hauptübersicht im InterAction Administrator per Doppelklick die InterAction API-Konfiguration.
- Wählen Sie Authentifizierung und dann HMAC-Einstellungen.
- Wählen Sie unter Schlüsselpaar zur Passwortverschlüsselung die Option Neue Schlüssel erstellen.
- Wählen Sie OK. Beachten Sie, dass das neue Schlüsselpaar erst gespeichert wird, wenn Sie OK wählen.
Sie können den öffentlichen Schlüssel anzeigen, indem Sie auf die Schaltfläche Öffentlichen Schlüssel anzeigen klicken. Den privaten Schlüssel können Sie nicht einsehen; dieser wird nur intern von der REST API zum Entschlüsseln des Passworts verwendet.
Erstellen des Schlüsselpaares zur Passwortverschlüsselung
[A] Wählen Sie dies, um das Schlüsselpaar zu erstellen.
[B] Wählen Sie dies, um den öffentlichen Schlüssel anzuzeigen und bei Bedarf in die Zwischenablage zu kopieren.
Der HMAC-Schlüssel
Der HMAC-Schlüssel wird verwendet, um die Authentifizierungsinformationen beim Senden an die REST API zu signieren. Dies ist erforderlich, wenn Sie entweder die InterAction-Authentifizierung oder die integrierte Windows-Authentifizierung (bei Verwendung eines zu vertrauenden Windows-Dienstkontos) verwenden.
Bei dieser Art der Authentifizierung verwendet die Anwendung den HMAC-Schlüssel, um die an die REST API gesendeten Informationen zu überprüfen.
So erstellen Sie den HMAC-Schlüssel:
- Öffnen Sie in der Hauptübersicht im InterAction Administrator per Doppelklick die InterAction API-Konfiguration.
- Wählen Sie Authentifizierung und dann HMAC-Einstellungen.
- Wählen Sie unter HMAC-Schlüssel die Option Neuen Schlüssel erstellen.
- Wählen Sie OK. Beachten Sie, dass der neue Schlüssel erst gespeichert wird, wenn Sie OK wählen.
[A] Wählen Sie dies, um den Schlüssel zu erstellen.
IIS-Einstellungen für das REST API Virtual Directory überprüfen und aktualisieren
Wenn Sie die REST API installieren, wird im IIS ein virtuelles Verzeichnis mit dem Namen InterActionAPI erstellt. Sie sollten die Einstellungen für dieses Verzeichnis überprüfen, um sicherzustellen, dass sie korrekt sind.
Beide Authentifizierungsarten (InterAction-Authentifizierung und integrierte Windows-Authentifizierung) erfordern folgende Einstellungen für das virtuelle Verzeichnis InterActionAPI:
- Anonymer Zugriff muss ausgewählt sein.
- Integrierte Windows-Authentifizierung muss ausgewählt sein.
So überprüfen und aktualisieren Sie die IIS-Einstellungen:
- Starten Sie auf dem Server, auf dem die REST-API installiert wurde, den IIS (in der Regel Start > Verwaltungstools > Internetinformationsdienste (IIS)-Manager).
- Erweitern Sie im Baumansicht den Eintrag für Ihren Server, dann Sites und anschließend Default Web Site.
- Wählen Sie unter Default Web Site InterActionAPI aus.
- Doppelklicken Sie auf Authentifizierung.
- Stellen Sie sicher, dass die richtigen Optionen ausgewählt sind.
- Anonymer Zugriff muss aktiviert sein.
- Windows-Authentifizierung muss aktiviert sein.
Nachdem Sie Änderungen an den IIS-Einstellungen vorgenommen oder die Authentifizierungseinstellungen der REST-API geändert haben, sollten Sie den IIS immer neu starten. Der genaue Befehl hierfür hängt von Ihrer IIS-Version ab; Details finden Sie in der Microsoft IIS-Dokumentation.
IIS-Einstellungen für Webanwendungen, die die API aufrufen, überprüfen und aktualisieren
Wenn Sie eine Webanwendung bereitstellen, die die InterAction API verwendet, müssen Sie diese Anwendung so konfigurieren, dass sie mit der gewählten Authentifizierungsmethode funktioniert. Dies ist zusätzlich zur Konfiguration der IIS-Einstellungen für die REST-API selbst erforderlich.
IIS-Einstellungen für die Webanwendung
Die spezifischen Einstellungen, die Sie für Ihre Webanwendung benötigen, hängen von der verwendeten Authentifizierungsmethode ab. Die folgende Tabelle fasst diese Einstellungen für die verfügbaren Authentifizierungsmethoden zusammen. Beachten Sie, dass dies die Einstellungen für die Webanwendung sind, die die API verwendet, nicht die Einstellungen für die REST-API selbst.
IIS-Einstellungen für Webanwendungen, die die REST-API aufrufen
| API-Authentifizierungsmethode | IIS-Einstellungen für die Webanwendung |
|---|---|
| InterAction-Authentifizierung |
Einstellungen für das virtuelle Verzeichnis:
|
| Integrierte Windows-Authentifizierung ohne zu vertrauendes Windows-Dienstkonto |
Einstellungen für das virtuelle Verzeichnis:
Weitere Einstellungen:
|
| Integrierte Windows-Authentifizierung mit zu vertrauendem Windows-Dienstkonto |
Einstellungen für das virtuelle Verzeichnis:
Anwendungspool-Einstellungen
|
| InterAction-Authentifizierung UND integrierte Windows-Authentifizierung ohne zu vertrauendes Windows-Dienstkonto |
Einstellungen für das virtuelle Verzeichnis:
Weitere Einstellungen:
|
| InterAction-Authentifizierung UND integrierte Windows-Authentifizierung mit zu vertrauendem Windows-Dienstkonto |
Einstellungen für das virtuelle Verzeichnis:
Anwendungspool-Einstellungen:
|
Webanwendungsidentität und Windows-Authentifizierung
Webanwendungen werden unter einer bestimmten Identität ausgeführt. Diese wird im IIS in den erweiterten Einstellungen für den Anwendungspool festgelegt.
IIS-Anwendungspool-Identitäts-Tab
Wenn Sie die REST-API so konfigurieren, dass sie die Windows-Authentifizierung verwendet, müssen Sie das für diese Identität verwendete Konto als zu vertrauendes Windows-Dienstkonto angeben. Sie können mehrere Konten durch Semikolons (;) getrennt angeben.
Idealerweise sollten Sie Ihre Webanwendung unter einem Domänendienstkonto ausführen. Falls das nicht möglich ist, können Sie das Network Service-Konto verwenden, das in SharePoint-Umgebungen standardmäßig verwendet wird. In diesem Fall sollte das zu vertrauende Windows-Dienstkonto wie folgt lauten:
- NT Authority\Network Service (wenn sich die REST-API und die Webanwendung auf demselben Server befinden)
- <Domäne>\<Computername>$ (wenn sich die REST-API und die Webanwendung auf verschiedenen Rechnern befinden).
Festlegen des zu vertrauenden Windows-Dienstkontos
[A] Geben Sie das Konto oder die Konten ein, unter denen die Webanwendungen ausgeführt werden, die mit der REST-API kommunizieren.
So überprüfen Sie das Konto, unter dem Ihre Webanwendung läuft:
- Starten Sie auf dem Server, auf dem die Webanwendung installiert wurde, den IIS (in der Regel Start > Verwaltungstools > Internetinformationsdienste (IIS)-Manager).
- Erweitern Sie im Baumansicht den Eintrag für Ihren Server und wählen Sie Anwendungspools aus. Die Anwendungspools werden in einer Tabelle angezeigt.
- Notieren Sie sich für den Anwendungspool Ihrer Anwendung den Wert in der Spalte Identität.
- Wenn Sie das Konto ändern müssen, klicken Sie mit der rechten Maustaste auf den Anwendungspool und wählen Sie Erweiterte Einstellungen. Bearbeiten Sie dann unter Prozessmodell die Zeile Identität.
So geben Sie das Konto, unter dem die Webanwendung läuft, als zu vertrauendes Windows-Dienstkonto an:
- Öffnen Sie in der Hauptentitätenliste im InterAction Administrator per Doppelklick die InterAction API-Konfiguration.
- Wählen Sie Authentifizierung.
- Wählen Sie unter API-Authentifizierungsmodus Integrierte Windows-Authentifizierung mit HMAC aktiviert aus.
-
Geben Sie das Konto, unter dem Ihre Webanwendung läuft, im Feld zu vertrauendes Windows-Dienstkonto ein.
Weitere Informationen finden Sie unter Webanwendungsidentität und Windows-Authentifizierung.
- Wählen Sie OK, um Ihre Änderungen zu speichern.
Konfiguration der Einstellungen für das virtuelle Verzeichnis der Webanwendung
So überprüfen und aktualisieren Sie die IIS-Einstellungen für Ihre Webanwendung:
- Starten Sie auf dem Server, auf dem die Webanwendung installiert wurde, den IIS (in der Regel Start > Verwaltungstools > Internetinformationsdienste (IIS)-Manager).
- Erweitern Sie im Baumansicht den Eintrag für Ihren Server, dann Sites und anschließend Default Web Site.
- Wählen Sie unter Default Web Site das virtuelle Verzeichnis Ihrer Anwendung aus.
- Doppelklicken Sie auf Authentifizierung.
-
Überprüfen und ändern Sie die Authentifizierungsoptionen nach Bedarf.
Siehe die Tabelle "IIS-Einstellungen für Webanwendungen, die die REST-API aufrufen" unter IIS-Einstellungen für Webanwendungen, die die API aufrufen, überprüfen und aktualisieren für die spezifischen Einstellungen, die Sie benötigen.
Nachdem Sie Änderungen an den IIS-Einstellungen vorgenommen oder die Authentifizierungseinstellungen der REST-API geändert haben, sollten Sie den IIS immer neu starten. Der genaue Befehl hierfür hängt von Ihrer IIS-Version ab; Details finden Sie in der Microsoft IIS-Dokumentation.
Verwendung von Windows-Integration und InterAction-Authentifizierung sowie Verbindung aus nicht vertrauenswürdigen Domänen
Wenn Sie sowohl die integrierte Windows-Authentifizierung als auch die InterAction-Authentifizierung verwenden und Clients aus nicht vertrauenswürdigen Domänen verbinden lassen möchten, sind zusätzliche Konfigurationsschritte erforderlich. Dazu gehört sowohl die Konfiguration im IIS als auch die Aktualisierung der web.config-Datei für die REST-API.
Sie müssen ein zweites virtuelles Verzeichnis (IIS 6.x) oder eine Anwendung (IIS 7.x) für die API erstellen und es im IIS so konfigurieren, dass die Windows-Authentifizierung deaktiviert ist. Dieses neue virtuelle Verzeichnis oder die Anwendung benötigt folgende Einstellungen:
- Erweitern Sie im IIS im Bereich Verbindungen den Knoten für Ihren Server > Sites.
- Klicken Sie mit der rechten Maustaste auf die gleiche Site, die die ursprüngliche InterActionAPI-Anwendung enthält, und wählen Sie Anwendung hinzufügen.
- Geben Sie für den Alias einen Namen ein. Sie benötigen diesen Namen später. Verwenden Sie einen Namen, der den Zweck dieser neuen Anwendung widerspiegelt, z. B. InterActionAPIAnon.
- Ändern Sie ggf. den Anwendungspool auf den gleichen Pool wie für die ursprüngliche InterActionAPI-Anwendung.
- Geben Sie für den Physikalischen Pfad das Installationsverzeichnis der REST-API an (normalerweise
C:\Inetpub\wwwroot\InterActionAPI). - Wählen Sie OK.
- Wählen Sie die neu erstellte Anwendung aus.
- Doppelklicken Sie auf den Eintrag Authentifizierung und stellen Sie sicher, dass Anonyme Authentifizierung aktiviert und Windows-Authentifizierung deaktiviert ist.
- Aktualisieren Sie die web.config-Datei der REST-API. Siehe „REST-API-Web.config-Datei aktualisieren“ weiter unten.
REST-API-Web.config-Datei aktualisieren
Aktualisieren Sie die web.config-Datei der API mit einer neuen appSetting, um dieses neue Verzeichnis zu kennzeichnen:
- Die web.config-Datei befindet sich im Installationsverzeichnis der REST-API. In einer Standardumgebung wäre dies C:\Inetpub\wwwroot\InterActionAPI.
- Sie müssen die Einstellung AnonymousVirtualDirectory mit dem Namen des zuvor erstellten virtuellen Verzeichnisses hinzufügen.
-
Wenn Ihr neues virtuelles Verzeichnis beispielsweise InterActionAPIAnon heißt, fügen Sie diese Zeile im <appSettings>-Abschnitt hinzu:
<add key="AnonymousVirtualDirectory" value="InterActionAPIAnon"/>
Die richtige URL für API-Anwendungen verwenden
Nachdem Sie das zweite virtuelle Verzeichnis eingerichtet haben, müssen API-Anwendungen, die sich aus nicht vertrauenswürdigen Domänen verbinden, eine URL verwenden, die das neue virtuelle Verzeichnis anstelle des normalen InterActionAPI-Verzeichnisses angibt.
Beispiel:
- Ihr REST-API-Server heißt "IAAPIServer".
- Das alternative virtuelle Verzeichnis heißt InterActionAPIAnon.
In diesem Fall würden Sie für Ihre API-Anwendungen folgende URLs verwenden:
-
Für Anwendungen, die sich aus vertrauenswürdigen Domänen verbinden:
http://IAAPIServer/interactionapi/
-
Für Anwendungen, die sich aus nicht vertrauenswürdigen Domänen mit InterAction-Authentifizierung verbinden:
http://IAAPIServer/InterActionAPIAnon/
Konfiguration sicherer Kommunikation (HTTP/HTTPS)
Sie können bei Bedarf SSL mit der REST-API verwenden. Dazu müssen Sie die Konfiguration in den IIS-Einstellungen vornehmen. Die REST-API verwendet Ihre IIS-Einstellungen für die sichere Kommunikation.
In der Regel konfigurieren Sie SSL auf Ebene der Default Web Site und nicht nur für die API.
Die Schritte zur Konfiguration von SSL unterscheiden sich je nach Ihrer IIS-Version.
Weitere Informationen zu SSL und zur Konfiguration von IIS finden Sie in der Microsoft-Dokumentation.
SSL-Konfiguration für IIS 7.x
Sie benötigen ein gültiges Zertifikat, um SSL zu konfigurieren.
- Installieren Sie Ihr Zertifikat, falls noch nicht geschehen.
- Wählen Sie im IIS im Bereich Verbindungen den Knoten für Ihren Server aus und doppelklicken Sie dann im rechten Bereich auf Serverzertifikate.
-
Wählen Sie Zertifikatsanforderung erstellen und schließen Sie den Assistenten ab.
Für Testzwecke können Sie die Option Selbstsigniertes Zertifikat erstellen verwenden. Dies ist für Tests sehr einfach und nützlich, aber nicht für Ihre Produktionsumgebung geeignet.
- Erstellen Sie eine SSL-Bindung für Ihren Server.
- Wählen Sie im Bereich Verbindungen den Knoten für Ihren Server > Sites > Default Web Site aus und wählen Sie dann im Bereich Aktionen Bindungen.
- Wählen Sie Hinzufügen, um eine neue Bindung hinzuzufügen.
- Wählen Sie https als Typ und das zuvor installierte SSL-Zertifikat aus, dann wählen Sie OK.
- Optional können Sie Ihren Server so konfigurieren, dass SSL erforderlich ist. Beachten Sie, dass dies für InterAction nicht erforderlich ist.
- Wählen Sie im Bereich Verbindungen den Knoten für Ihren Server > Sites > Default Web Site > InterActionAPI aus.
- Doppelklicken Sie im rechten Bereich auf SSL-Einstellungen.
- Aktivieren oder deaktivieren Sie das Kontrollkästchen SSL erforderlich.
- Starten Sie nach Abschluss dieser Schritte den IIS neu.
Nachdem Sie den IIS für die Verwendung von SSL konfiguriert haben, müssen die Client-Rechner, die per HTTPS auf die API zugreifen, so konfiguriert werden, dass sie dem Aussteller des Serverzertifikats vertrauen.
Weitere Informationen zur Konfiguration von IIS mit SSL-Sicherheit finden Sie in der Microsoft-Dokumentation.
Verwalten von Serverzertifikaten in IIS7
SSL-Anforderung in IIS Version 7.x festlegen