API-Schlüsselauthentifizierung für MID-Webserver konfigurieren

Authentifizieren Sie von Clients eingehende Anforderungen an die MID-Webserver erweiterung mithilfe der API-Schlüsselauthentifizierung. Die API-Authentifizierung ist eine sichere und einfache Möglichkeit, Ihre Anforderung zu authentifizieren. Sie können einen MID-Webserver-API-Schlüssel erstellen oder ändern.

Vorbereitungen

Erstellen Sie eine MID-Webserver erweiterung, um die API-Schlüsselauthentifizierung zu verwenden, wie in MID-Webserver erweiterung konfigurieren beschrieben. Stellen Sie sicher, dass Sie im Feld Authentifizierungstyp der Erweiterung API-Schlüssel auswählen.

Erforderliche Rolle: event_mgmt_admin

Warum und wann dieser Vorgang ausgeführt wird

Standardmäßig können Sie in einer Instanz maximal 10 API-Schlüssel erstellen. Um diese Zahl zu ändern, ändern Sie auf der Seite „Systemeigenschaften“ den Wert der Eigenschaft mid.webserver.max.api.keys.

Wenn Sie in der globalen Domäne arbeiten, während die Domänentrennung aktiviert ist, sind API-Schlüssel für alle Erweiterungen verfügbar, unabhängig von ihrer Domäne. Wenn Sie in einer bestimmten Domäne arbeiten, stehen API-Schlüssel für Erweiterungen in dieser Domäne, den übergeordneten Domänen und der globalen Domäne zur Verfügung.

Sie können API-Schlüssel so konfigurieren, dass sie an einem bestimmten Datum ablaufen.

Wenn Sie eine neue Erweiterung mit API-Schlüsselauthentifizierung erstellen (oder eine vorhandene aktualisieren, um die API-Schlüsselauthentifizierung zu verwenden), wird vom System nach einem verfügbaren API-Schlüssel für die Erweiterung gesucht. Wenn kein API-Schlüssel verfügbar ist, wird vom System einer erstellt.

Prozedur

1. Navigieren zu Alle > MID-Server > Profile und Bereitstellungen > MID-Webserver API-Schlüsselan.
2. Erstellen Sie entweder einen neuen API-Schlüssel oder ändern Sie einen vorhandenen API-Schlüssel.
   • So erstellen Sie einen neuen API-Schlüssel:
     1. Wählen Sie Neu.
     2. Füllen Sie im Formular „MID-Webserver API-Schlüssel“ die Felder aus.

        Tabelle : 1. Formular „MID-Webserver API-Schlüssel“

        Feld	Beschreibung
        Name	Name für den API-Schlüssel
        Aktiv	Option zur Aktivierung des API-Schlüssels
        Authentifizierungsschlüssel	Schreibgeschützter codierter Wert des Authentifizierungsschlüssels. Erst nach der Konfiguration des Schlüssels wird ein Wert angezeigt.
        Läuft ab	Option zum Festlegen eines Ablaufdatums für den API-Schlüssel. Abgelaufene, deaktivierte oder gelöschte API-Schlüssel werden von der Webservererweiterung nicht akzeptiert.

     3. Wählen Sie Absenden aus, um den API-Schlüssel zu speichern.

        Der API-Schlüssel wird auf der Seite „MID-Webserver API-Schlüssel“ angezeigt.

   • So ändern Sie einen vorhandenen API-Schlüssel:
     1. Navigieren zu MID-Server > Profile und Bereitstellungen > MID-Webserver API-Schlüsselan.
     2. Wählen Sie auf der Seite einen API-Schlüssel aus.
     3. Wählen Sie im Abschnitt Zugehörige Links die Option API-Schlüssel anzeigen aus.
     4. Kopieren Sie den API-Schlüssel, der im Dialogfeld „MID-Webserver“ angezeigt wird.

        Wenn Sie eine Verbindung mit einer MID-Webserver erweiterung herstellen, die mit der API-Schlüsselauthentifizierung konfiguriert ist, fügen Sie einen API-Schlüssel, auf den die Erweiterung zugreifen kann, im Autorisierungsheader der Anforderung im folgenden Format ein:

        Key <API_KEY>

        Dabei ist <API_KEY> der Wert des API-Schlüssels, der nach Auswahl von API-Schlüssel anzeigen angezeigt wird.
     5. Wählen Sie Absenden aus.