Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Einrichten der API-Sicherheit

Im Rahmen des API-Gestaltungsprozesses müssen Sie festlegen, welche Nutzer auf Ihre API zugreifen (Authentifizierung) und welche Aktionen sie ausführen können (Autorisierung).

InformationshinweisAnmerkung: Talend Cloud API Designer ermöglicht Ihnen die Definition von Sicherheitsparametern zu Gestaltungs- und Dokumentierungszwecken, allerdings wird die Sicherheit bei Verwendung der API-Dokumentation in Talend Studio nicht automatisch implementiert.

Unter Umständen möchten Sie einfach nur eine allgemeine Sicherheit für die gesamte API einrichten oder aber detailliertere Richtlinien mit spezifischer Sicherheit für kritische Ressourcen festlegen.

Nach Bedarf können Sie auch bestimmen, dass bestimmte Operationen ohne Authentifizierung frei zugänglich sind.

Talend Cloud API Designer kann alle diese Szenarien mithilfe der Haupt-Sicherheitstypen verwalten:
  • Basisauthentifizierung
  • Bearer-Authentifizierung
  • Digest-Authentifizierung
  • OAuth 1.0
  • OAuth 2.0
  • OpenID Connect
  • Benutzerdefiniert / API-Key
  • Pass Throug

Eine Cookie-Authentifizierung wird nicht unterstützt.

Erstellen von Sicherheitsschemas

Erstellen Sie ein Sicherheitsschema, das dann global in Ihrer API-Version bzw. in einzelnen Elementen verwendet werden soll.

Prozedur

  1. Navigieren Sie zur allgemeinen Informationsseite der API.
  2. Scrollen Sie zur Section SECURITY SCHEMES (SICHERHEITSSCHEMAS) und klicken Sie auf Add (Hinzufügen), um ein neues Schema zu erstellen.
  3. Wählen Sie einen Type (Typ) in der Dropdown-Liste aus und geben Sie einen Name (Namen) ein.
  4. Optional: Geben Sie eine Description (Beschreibung) ein.
  5. Geben Sie andere spezifische Parameter für den ausgewählten Typ ein.

    Example

    Beispiel einer Sicherheitsschemadefinition.
  6. Klicken Sie auf Save (Speichern).

Ergebnisse

Ihr Sicherheitsschema wird dann erstellt und kann in den globalen Einstellungen der API bzw. in spezifischen Ressourcen und Operationen verwendet werden.

Definieren der API-Sicherheit

Definieren Sie Sicherheitsschemas für Ihre API, Ressourcen und Operationen.

Prozedur

  1. Klicken Sie auf den Namen der API, um die allgemeinen Informationen aufzurufen.
  2. Fügen Sie die gewünschten Sicherheitsschemas hinzu und wählen Sie diejenigen aus, die global auf Ihre API-Version angewendet werden sollen.
    In diesem Beispiel wird die Petstore API durch petstore_auth mit dem Anwendungsbereich write:pets gesichert.
  3. Klicken Sie auf Save (Speichern).
  4. Wählen Sie eine Ressource und dann die Sicherheitsschemas aus, die auf alle Operationen der Ressource angewendet werden sollen.
    Oder Sie wählen eine Operation aus, um für diese eine spezifische Sicherheit festzulegen.
    In diesem Beispiel wird die Methode Find Pets by tags (Haustiere nach Tags suchen) mit petstore_auth gesichert.
  5. Klicken Sie auf Save (Speichern).

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!