API-Schlüssel

Info

• Direktlink: konfipay (DE) | konfipay (CH)

• Navigationspfad: Mandantenverwaltung > API > API-Schlüssel

• Schnellnavigation: API Schlüssel

• Benutzergruppen: Admin, Vollzugriff, Verwaltung

• Benötigte Berechtigungen: API Schlüssel anzeigen/Schlüssel hinzufügen und entfernen

Allgemeine Informationen

Diese Seite ist eine Übersicht über die API-Schlüssel eines Mandanten. Ein API-Schlüssel dient zur Authentifizierung bei Verwendung der konfipay API. Die API-Endpunkte sind nicht öffentlich zugänglich und setzen für deren Nutzung eine erfolgreiche Authentifizierung voraus. Weitere Details zur Authentifizierung mittels API-Schlüssel sind in der API-Dokumentation beschrieben.

Speichern Sie Ihre API-Schlüssel nicht an öffentlich zugänglichen Stellen und geben Sie diese nicht weiter. Wer Ihre API-Schlüssel kennt, kann Ihre Konten über die API ansteuern und ggf. nicht autorisierte Zahlungen senden!

Schlüssel-Übersicht

In der Schlüssel-Übersicht kann ein Schlüssel über das Auge-Symbol angezeigt werden bzw. in die Zwischenablage kopiert werden. Ein Schlüssel kann bei Bedarf deaktiviert und später wieder aktiviert werden - so lange er deaktiviert ist, kann er nicht zum API-Zugang genutzt werden.

Schlüssel neu generieren oder löschen

Der Schlüssel kann auch neu generiert oder komplett gelöscht werden. Hierbei gilt zu beachten, dass die Änderung, Löschung oder Deaktivierung eines API-Schlüssels dazu führt, dass alle Client-Anwendungen, welche diesen Schlüssel verwenden, sich gegenüber konfipay anschließend nicht mehr authentifizieren können. Der neue Schlüssel muss dann auch wieder in der externen Applikation hinterlegt werden.

Schlüssel hinzufügen

Über Hinzufügen kann ein neuer API-Schlüssel generiert werden. Zuerst benötigt dieser eine aussagekräftige Bezeichnung, z.B. mit dem Namen der Applikation, für die der Schlüssel verwendet werden soll.

Berechtigungen des Schlüssels

Die Berechtigungen des Schlüssels können ebenfalls festgelegt werden, d.h. auf welche API-Funktionen mit dem Schlüssel zugegriffen werden kann. Wenn eine Applikation z.B. nur zum Abruf von Kontoumsätzen verwendet werden soll, kann es aus Sicherheitsgründen sinnvoll sein, den Schlüssel auch nur für bankfachliche Dokumente zuzulassen.