API-Schlüssel
API-Schlüssel dienen der eindeutigen Identifizierung eines Schnittstellennutzers und schützen APIs vor einem unberechtigtem Zugriff. Du oder externe Dienstleister können mit diesen "Tokens" sicher auf genau definierte Daten zugreifen oder bestimmte Aktionen ausführen.
[note] Da API-Schlüssel einen direkten Zugriff auf geschützte Daten erlauben, solltest Du damit immer sorgsam umgehen und sie nicht ungesichert abspeichern. [/note]
API-Schlüssel verwalten
API-Schlüssel verwaltetst Du im Einstellungs-Bereich über Einstellungen > Integration > API Schlüssel. Alternativ erreichst Du die Token-Übersicht auch über den Kurzbefehl GAK.
Auf der Übersichtsseite werden Dir alle existierenden API-Schlüssel angezeigt. Die Tokens werden nach Einsatzgebiet gegliedert:
- interne Shop-Tokens
- externe Shop-Tokens
- Händler-Token
- interne CMS-Tokens
Je nach Einsatzgebiet regeln API-Schlüssel daher den Zugriff auf bestimmte Bereiche und Rechte. Details zu den unterschiedlichen Berechtigungen erfährst Du von Deinem technischen Ansprechpartner.
Folgende Informationen werde Dir pro Schlüssel angezeigt:
- letzte vier Zeichen des Schlüssels
- Erstelldatum
- Ersteller
- Notiz (falls angelegt)
API-Schlüssel erstellen
Einen neuen API-Schlüssel erstellst Du für den jeweiligen Einsatz über den +Token Button. Mit Klick auf den Button öffnet sich ein Fenster, in dem Du eine Notiz für den Schlüssel hinterlegen kannst, also z.B. den konkreten Verwendungszweck oder Händler. Das Notizfeld ist zwar optional, doch wir empfehlen stark dessen Nutzung. Es erleichtert Dir den täglichen Umgang mit API-Schlüsseln und Du kannst beispielsweise schnell erkennen, wann ein Token veraltet ist oder nicht mehr genutzt wird und gelöscht oder ausgetauscht werden sollte.
Beim Generieren eines Tokens werden Erstelldatum und Ersteller automatisch gespeichert und Dir hinterher der Schlüssel angezeigt. Du kannst ihn direkt über einen Button in Deine Zwischenablage speichern. Der erstellte Token wird Dir nur ein einziges Mal angezeigt. Verlässt Du die Übersichtsseite, siehst Du ihn später nur noch verschlüsselt. Das Anzeigen des kompletten API-Schlüssels ist nicht mehr möglich.
[note] Da das nachträgliche Kopieren eines Tokens nicht möglich ist, musst Du notfalls einen neuen API-Schlüssel erstellen und dann diesen nutzen. [/note]
API-Schlüssel löschen
API-Schlüssel lassen sich einzeln über das Papierkorb-Symbol entfernen. Durch das Löschen eines API-Schlüssels wird der Zugang über diesen Schlüssel sofort deaktiviert. Diese Aktion lässt sich nicht wieder rückgängig machen.
