Sichern einer API

Verwalten der Consumer

Auf die ausgehend von Ihrem Datensatz generierte API kann nur über die Basis- oder API-Key-Authentifizierung zugegriffen werden. Wählen Sie im API-Konfigurationsformular die Authentifizierungsmethode aus, wenn Sie die zulässigen Consumer hinzufügen.

• Legen Sie für die Basis-Authentifizierung einen Benutzernamen und ein Passwort für den Consumer fest.

  Um die API aufrufen zu können, müssen Sie einen Authorization-Header (Authentifizierung) hinzufügen. Der Wert sollte Basic (Basis) sein, gefolgt von der in Base64 codierten Zeichenfolge username:password (Benutzername:Passwort). Beispiel: Basic dXNlcm5hbWU6cGFzc3dvcmQ=.

• Für die API-Key-Authentifizierung verwenden Sie den generierten Schlüssel im Header Ihres Requests.

  Um die API aufrufen zu können, müssen Sie einen Authorization-Header (Authentifizierung) hinzufügen. Der Wert sollte Token sein, gefolgt von dem bei der API-Konfiguration generierten API-Key. Beispiel: Token apic.data-api_3KF0MT_EalJeneqZZC3BVTm9J3ft6s66vAb3g_EgI0K7.

Verwenden von HTTPS

Wenn Sie einen Datensatz mit einer Remote Engine Gen2-Verbindung verwenden, können Sie HTTPS für Ihre API einrichten. Aktualisieren Sie dazu die NGINX-Konfiguration im Ordner default/nginx im Verzeichnis von Remote Engine Gen2.

Um Sie bei der Einrichtung einer HTTPS-Basiskonfiguration zu unterstützen, enthält die Datei default/nginx/nginx.conf ein kommentiertes Konfigurationsbeispiel.

1. Kommentieren Sie die folgende Zeile aus:

    listen              9102; # Do not change this port number

2. Heben Sie die Auskommentierung der folgenden Zeilen auf:

   # listen              9103 ssl;  # Do not change this port number
       # ssl_certificate     cn.crt;    # The name of your public certificate file. Put it next to this nginx.conf
       # ssl_certificate_key cn.key;    # The name of your private key file. Put it next to this nginx.conf

   Die Dateien .crt und .key müssen im Ordner default/nginx gespeichert sein.

3. Vergewissern Sie sich, dass die in default/nginx/nginx.conf für die Dateien .crt und .key referenzierten Namen den tatsächlichen Dateinamen entsprechen.