In diesem Abschnitt werden bewährten Praktiken erläutert, mit denen Sie mit der REST-API des Secure Edge Portal die besten Ergebnisse erzielen:
- Geben Sie jeder Integration einen eigenen API-Schlüssel und nutzen Sie beschreibende Namen, die anzeigen, welcher Schlüssel welcher Integration zugeteilt wird. Dadurch stellen Sie bei einer Kompromittierung eines API-Schlüssels sicher, dass Sie diesen Schlüssel entfernen können, ohne den Zugriff auf Ihre restlichen Integrationen zu verlieren.
- Falls Sie einen API-Schlüssel teilen müssen, erstellen Sie stattdessen einen neuen Schlüssel und geben Sie diesem einen beschreibenden Namen, um ihn bei Bedarf entfernen zu können.
- Verschicken Sie einen API-Schlüssel niemals per E-Mail. Sonst könnte es bei einer Kompromittierung Ihres E-Mail-Kontos könnte es zu einem unerlaubten Zugriff auf Ihr Secure-Edge-Portal-Konto kommen.
- Veröffentlichen Sie keinen API-Schlüssel (beispielsweise in Screenshots, Videos oder Dokumentation). Es ist nicht immer ausreichend, Daten unscharf zu machen. Am besten Sie nutzen in Ihrem Grafikprogramm „Cut“-Funktionen , um die Daten vollständig zu löschen.
- Der Zugriff auf jeden API-Endpunkt ist durch die Rolle des Benutzers festgelegt, der den API-Schlüssel erstellt hat. Erstellen Sie ein separates Benutzerkonto mit den gewünschten Berechtigungen und nutzen Sie dieses Konto zur Erstellung des API-Schlüssels, um eine präzisere Zugriffssteuerung sicherzustellen.
- Prüfen Sie immer auf Fehler und Ausnahmen. Falls auf einen API-Aufruf hin ein Fehler auftritt, protokollieren Sie den Aufruf so detailliert wie möglich. Integrieren Sie die von Ihnen durch die Fehlerreaktion und Headers übermittelten Daten.
- Häufige API-Aufrufe (beispielsweise, um den Status zu prüfen), können Ihre Anwendung verlangsamen. Wir empfehlen, dass Sie nur neue Daten synchronisieren und im Cache häufig genutzte Werte speichern, die sich nicht häufig ändern.