API-Schlüssel
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsAPI-Schlüssel erstellen
Bei der Planung der benötigten API-Schlüssel müssen Sie berücksichtigen, welche Daten die API-Clients jeweils benötigen. Aus Sicht der API-Schlüsselverwaltung ist es normalerweise am besten, für jede Partei, die die APIs nutzen wird, eindeutige API-Schlüssel zu haben.
Im Beispielszenario wären die Integrationsprozesse der Finanzabteilung eine API-Client-Partei. Es ist besser, Finanzintegrationen mit einem bestimmten API-Schlüssel als einen API-Client zu gruppieren, als nur einen API-Schlüssel für jeden internen API-Anwendungsfall zu erstellen. Auf diese Weise ist es viel einfacher zu verfolgen, wo die Finanz-APIs verwendet werden, und feinere Grenzen für die API-Verwendung festzulegen.
In diesem Fall gehen wir davon aus, dass es keine Notwendigkeit für separate Ratenbegrenzungen für die Kredit-API und die Investitions-API gibt. In diesem Fall können wir einen API-Schlüssel verwenden, um sowohl auf die Kredit-API als auch auf die Investitions-API zuzugreifen.
Schritte zum Definieren eines API-Schlüssels für Finanzintegrationen
1) Navigieren Sie in der Frends-Web-Benutzeroberfläche zuVerwaltung > API-Schlüssel
2) Klicken Sie auf das "Neuer API-Schlüssel" Taste
3) Füllen Sie die API-Schlüsselfelder wie in diesem Screenshot aus:
Kommentare zu den Feldern:
Name: Es ist besser, lange und beschreibende Namen zu verwenden. An diesem Namen erkennen wir direkt, dass er für die Finanzintegrationen in der Entwicklungsumgebung gedacht ist.
Umfeld: In Frends müssen Sie für jede Umgebung einen separaten Schlüssel erstellen.
Schlüssel: Geben Sie hier nichts ein. Der Schlüssel wird automatisch generiert, wenn Sie auf die Schaltfläche Speichern klicken.
Regelsätze: Lassen Sie dieses Feld vorerst leer. Wenn Sie die Regelsätze bereits haben, können Sie die mit diesem Schlüssel verknüpften Regelsätze auswählen.
Anforderungslimit: Es wird empfohlen, immer ein Anforderungslimit festzulegen. Selbst wenn es nur eine sehr begrenzte Anzahl von Anforderungen an die APIs mit diesem API-Schlüssel gibt, schützt das Anforderungslimit die API und die möglichen Backend-Systeme, mit denen die API interagiert, vor übermäßiger Nutzung. Eine übermäßige Nutzung kann beispielsweise versehentlich bei der Entwicklung des API-Clients auftreten, der unsere Finanz-APIs nutzt. Ein weiterer Fall für übermäßige Nutzung könnte sein, wenn der API-Schlüssel versehentlich oder infolge eines Datenverstoßes verloren geht. In beiden Fällen hilft das Ratenlimit, die Auswirkungen solcher Szenarien abzumildern.
4) Klicken Sie aufSpeichernTaste.
Der Schlüssel wird nun generiert und im Feld „Schlüssel“ angezeigt. Diese Zeichenfolge aus Zahlen und Buchstaben ist wie eine Kombination aus Benutzername und Passwort. Jeder, der den API-Schlüssel hat und weiß, auf welche APIs er Zugriff gewährt, kann ihn verwenden. Deshalb ist es wichtig, ihn nur an die Entwickler oder Partner zu senden, die ihn benötigen, und eine sichere Methode zum Senden des API-Schlüssels zu verwenden. Es empfiehlt sich auch, den API-Schlüssel und die Informationen, für welche APIs der Schlüssel gültig ist, separat zu senden.
Wiederholen Sie abschließend die Schritte, um einen API-Schlüssel für das Partnerunternehmen (Acme Webdev) zu erstellen, der ihm Zugriff auf die Campaign-API gewährt. Legen Sie in den Feldern des API-Schlüssels bitte folgende Werte fest:
Ansonsten ist dieser API-Schlüssel dem Schlüssel für Finanzintegrationen sehr ähnlich, aber in diesem Fall setzen wir das Anforderungslimit aufPro Minute, da während der Marketingkampagne mit diesem API-Schlüssel eine größere Belastung auftreten kann. Wenn es mehr als 50 Anfragen mit diesem API-Schlüssel pro Minute gibt, gibt Frends einen Fehler zurück.Anforderungslimit überschritten, für den API-Client. Wenn seit der ersten API-Anfrage mit dem API-Schlüssel eine Minute vergangen ist, akzeptiert Frends wieder neue Anfragen, bis das Anfragelimit überschritten wird.
Speichern Sie den Schlüssel abschließend mit einem Klick aufSpeichernTaste.
Der nächste Artikel istEinführung in die Weitergabe eines API-Schlüssels an die Frends API von einem Client
Verwandte ArtikelAPI-SchlüsselAuthentifizierung zum Anzeigen der API-SpezifikationenEinführung in die API-AuthentifizierungEinführung in die API-Authentifizierung mit FrendsEinführung in API-Schlüssel