Sicherheitsframework für Unica-APIs

Unica Platform stellt das Sicherheitsframework für durch Unica-Produkte implementierte APIs bereit.

Mithilfe eines Satzes Konfigurationseigenschaften auf der Seite Einstellungen > Konfiguration können Entwickler die Sicherheit der durch Unica-Produkte bereitgestellten APIs folgendermaßen festlegen.

  • Für eine bestimmte Produkt-API kann der Zugriff auf das Produkt blockiert werden.
  • Für eine bestimmte Produkt-API kann festgelegt werden, dass HTTPS für die Kommunikation zwischen der angegebenen API und dem Produkt erforderlich ist.
  • Für eine bestimmte Produkt-API kann festgelegt werden, dass Authentifizierung für die Kommunikation zwischen der angegebenen API und dem Produkt erforderlich ist.

Die Konfigurationseigenschaften, mit der die API-Sicherheit gesteuert wird, befinden sich in der Kategorie Unica Marketing Platform | Sicherheit |API-Management. Zu jedem Produkt gibt es eine Konfigurationseigenschaftsvorlage, mit der Sie neue Sicherheitseinstellungen für die durch das Produkt bereitgestellten APIs erstellen können.

Sie können die Sicherheitseinstellungen für eine API festlegen und ändern, z.B. zum Testen oder Bereitstellen einer Einheit oder auch allgemein während des Lebenszyklus der APIs.

Das Sicherheitsframework unterstützt momentan APIs nur für Unica Campaign.

Das Unica Platform-Sicherheitsframework unterstützt die folgenden Authentifizierungsoptionen für den Zugriff auf geschützte APIs. Sie können je nach Umgebung eine dieser Optionen verwenden.

  • Interne Benutzer, die bei Unica Platform registriert sind, können mit ihren Unica Platform-Anmeldeberechtigungsnachweisen authentifiziert werden, um ein sicheres Token zu erhalten.
  • Externe Benutzer, die einer Föderation angehören, die von Unica Platform verwendet wird, können über den Identitätsproviderserver authentifiziert werden.

Authentifizierung interner Benutzer mit der Unica Platform-Anmeldungs-API

Um interne Benutzer in Clientanwendungen zu authentifizieren, verwenden Sie die Unica Platform login-API zum Erstellen des sicheren Tokens. Sie können dann jede beliebige geschützte API aufrufen, indem Sie zusätzlich zu den von der API selbst erwarteten Parametern die erforderlichen Parameter im Anforderungsheader übergeben.

Der Sicherheitsfilter fängt diese geschützten Anforderungen ab, prüft sie und gibt sie dann zur Verarbeitung weiter.

Nachdem der Unica Platform-Benutzer authentifiziert wurde, fügt der Unica Platform-Sicherheitsfilter der Anforderung den Anmeldenamen als Attribut des Schlüssels USER_NAME_STRING hinzu, bevor er ihn zur Verarbeitung an das Produkt übergibt.

Die sicheren Tokens haben eine Standardlebensdauer von 15 Sekunden. Wenn die Lebensdauer des Tokens abgelaufen ist, kann es nicht mehr zum Aufrufen einer geschützten API verwendet werden. Jedes Mal, wenn die Unica Platform login-API für einen Benutzer aufgerufen wird, werden die vorherigen Sicherheitstokens des Benutzers inaktiviert.

Sie können die Lebensdauer von sicheren Tokens ändern, indem Sie den Wert der Eigenschaft Tokenlebensdauer auf der Seite Einstellungen > Konfiguration in der Kategorie Allgemein | Sonstiges festlegen.

Beispiel-URL

http[s]://host:port/unica/api/manager/authentication/login/

Headerparameter

Tabelle 1. Headerparameter für die Anmeldungs-API bei internen Benutzern
Parameter Beschreibung
m_user_name Der Unica Platform-Anmeldename des internen Benutzers.
m_user_password Das Unica Platform-Kennwort des internen Benutzers als Klartext.

Antwort

Wenn die Anmeldung erfolgreich ist, lautet die Antwort HTTP 200 mit folgenden JSON-Daten.

  • m_tokenId - zufällig generiertes Token
  • m_user_name - Benutzername des angemeldeten Benutzers
  • createDate - Zeitmarke in folgendem Format, wobei die Zeitzone IST ist:

    Mon Jul 06 18:23:35 IST 2015

Wenn die Anmeldung wegen falscher Berechtigungsnachweise fehlschlägt, lautet die Antwort HTTP 401 (nicht berechtigt). Wenn festgelegt wurde, dass die login-API geblockt wird, lautet die Antwort 403 (unzulässig). Wenn die Konfiguration der login-API die Verwendung von HTTPS vorsieht und die API über HTTP aufgerufen wird, lautet die Antwort 403 (unzulässig).

Um interne Benutzer abzumelden, verwenden Sie die Unica Platform logout-API.

Abmeldung interner Benutzer mithilfe der Unica Platform-Abmeldungs-API

Verwenden Sie die Unica Platform logout-API, um interne Benutzer abzumelden und das Sicherheitstoken zu löschen.

Die logout-API ist standardmäßig geschützt. Die Authentifizierungsparameter werden im Anforderungsheader zu vordefinierten Schlüsseln erwartet.

Beispiel-URL

http[s]://host:port/unica/api/manager/authentication/logout/

Headerparameter

Tabelle 2. Headerparameter für die Abmeldungs-API
Parameter Beschreibung
m_user_name Der Unica Platform-Anmeldename des internen Benutzers.
m_tokenId Das durch die Authentifizierung erhaltene sichere Token.
api_auth_mode Verwenden Sie für interne Benutzer den Wert manager.

Antwort

Wenn die Authentifizierung erfolgreich ist, lautet die Antwort HTTP 200 und das Sicherheitstoken wird gelöscht. Wenn die Antwort HTTP 200 lautet, sollte die Clientanwendung die Abmeldung bestätigen.

Wenn die Authentifizierung fehlschlägt, lautet die Antwort HTTP 401.

Authentifizierung und Abmeldung externer Benutzer über eine Föderation

Wenn Unica Platform in eine unterstützte Föderation integriert ist, können sich Benutzer bei ihrem eigenen System anmelden und die Clientanwendung erhält über den Identitäts-Provider-Server von Unica Platform ein Token.

Nachdem ein föderierter Benutzer authentifiziert wurde, wird sein Unica Platform-Anmeldename der Anforderung als Attribut des Schlüssels USER_NAME_STRING hinzugefügt.

Die Abmeldung sollte am Identitäts-Provider-Server stattfinden.

Headerparameter

In der folgenden Tabelle werden die Headerparameter beschrieben, die bei der Authentifizierung über den Identitäts-Provider-Server von Unica Platform verwendet werden.

Tabelle 3. Headerparameter bei einer Föderation
Parameter Beschreibung
f_userId Benutzer-ID in der Föderation.
f_clientId Client-ID in der Föderation.
f_spId Service-Provider-ID in der Föderation.
f_tokenId Single-Sign-on-Token des Identitäts-Provider-Servers.
api_auth_mode Verwenden Sie für die föderierte Authentifizierung den Wert fsso.

Antwort

Die Antwort lautet HTTP 200 mit zusätzlichen API-abhängigen Elementen.