Authentifizieren Sie den Zugriff auf die API-Spezifikation mit API-Schlüsseln
EGeschrieben vonErkka Honkavaara Vor über einer Woche aktualisiertAb Frends 5.2 können Sie die API-Spezifikation so einstellen, dass beim Anzeigen in der Swagger-Benutzeroberfläche oder beim Herunterladen der JSON-Datei ein API-Schlüssel erforderlich ist.
Um dies einzurichten, müssen Sie zunächst den API-Schlüssel-Regelsatz erstellen, der den Zugriff auf die Datei „docs.json“ für die API-Spezifikation ermöglicht. Gehen Sie dazu auf die Seite „API-Schlüssel“ und erstellen Sie einen neuen Regelsatz.
Legen Sie den neuen Regelsatz fest, um GET-Anfragen an den API-Spezifikationspfad zuzulassen. Er sollte „/api/docs“ + Basispfad + „/docs.json“ lauten, z. B. „/api/docs/api/insurancedata/v1/docs.json“. (Oder, wenn der Agent noch auf 5.2.1 oder 5.2.2 läuft, einfach „/api/insurancedata/v1/docs.json“)
Nachdem Sie den neuen Regelsatz gespeichert haben, können Sie damit pro Umgebung API-Schlüssel erstellen.
Um die API-Spezifikation so einzustellen, dass eine API-Schlüsselauthentifizierung erforderlich ist, gehen Sie zur API-Verwaltungsseite und öffnen Sie die API-Spezifikation in der Agentengruppe, in der Sie die Einstellung aktivieren möchten. Klicken Sie dann auf das Schlosssymbol neben der Schaltfläche „Swagger UI“.
Nachdem diese Einstellung aktiviert wurde, ist für jeden Versuch, auf die Swagger-Benutzeroberfläche zuzugreifen oder das JSON herunterzuladen, ein gültiger API-Schlüssel erforderlich. Die API-Spezifikation wird auch nicht in der Hauptspezifikationsliste des Agenten angezeigt, sodass nur mit Kenntnis der direkten URI darauf zugegriffen werden kann.
Verwandte ArtikelErstellen einer Frends-APIAPI-SchlüsselZugriff auf die Verwaltungs-API mit Swagger UIEinführung in die Konfiguration einer Authentifizierungsmethode für eine APIEinführung in die API-Authentifizierung mit Frends