Grundlagen zu API-Schlüsseln
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsEinführung in API-Schlüssel
API-Schlüssel werden zur Authentifizierung eines Anrufers verwendet, der eineHTTPoderAPI-Triggerdas heißt, es wird eine API-Schlüsselauthentifizierung verwendet. Ein API-Schlüssel ist nur für eine bestimmte Umgebung gültig, was bedeutet, dass Sie für jede Umgebung eindeutige API-Schlüssel erstellen müssen. Die Zugriffsrechte für API-Schlüssel werden durch die darauf angewendeten Regelsätze bestimmt.
Ein API-Schlüssel kann von mehreren API-Clients gemeinsam genutzt werden. Normalerweise empfiehlt es sich jedoch, für jeden API-Client oder jede Partei, die Zugriff auf eine API oder einen Satz von APIs benötigt, eindeutige API-Schlüssel zu erstellen.
API-Schlüssel sind wie Türschlüssel. Der Inhaber des Schlüssels kann alle Türen öffnen, die der Schlüssel öffnen kann. Der Inhaber eines API-Schlüssels kann auf alle APIs zugreifen, auf die der API-Schlüssel Zugriff gewährt. Aus diesem Grund ist es wichtig, sicherzustellen, dass API-Schlüssel in den API-Clients sicher gespeichert werden und bei API-Anfragen sichere HTTPS-Protokolle verwendet werden.
In Frends müssen Sie neben API-Schlüsseln auch Regelsätze definieren. Ein API-Schlüssel definiert, wer oder welche Partei auf die API zugreift, und schließlich definieren die mit dem API-Schlüssel verknüpften Regelsätze, auf welche APIs und welche Vorgänge der API-Schlüssel zugreifen darf.
Dieses Bild veranschaulicht, wie die API-Schlüssel und die Regelsätze zusammen den Zugriff auf die Frends-APIs definieren:
Der nächste Artikel istEinführung in die Definition der Verwendung von API-Schlüsseln in der OpenAPI-Spezifikation
Verwandte ArtikelErstellen einer Frends-APIEinführung in das Testen einer API und API – SchlüsselkonzepteEinführung in die API-Authentifizierung mit FrendsBeispiel zum Erstellen von API-SchlüsselnEinführung in die Bereitstellung von APIs und die API-Versionskontrolle