API-Schlüssel

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!

Hier finden Sie eine Übersicht über alle API-Schlüssel Ihres Mandanten. Ein API-Schlüssel wird benötigt, um mit einer Software-Anwendung Zugang zur konfipay-API zu erhalten, da die API-Endpunkte nicht öffentlich sind.

In der Übersicht sehen Sie auf einen Blick die Bezeichnung eines Schlüssels, ob dieser aktiv ist, wann er erstellt wurde (Spalte: “Zeitstempel”) und wann er zum letzten Mal zur Authentifizierung an der API verwendet wurde (Spalte: “Letzte Verwendung“). Um einen API-Schlüssel in die Zwischenablage zu kopieren, klicken Sie auf das Kopiersymbol neben dem Schlüssel:

Schlüssel hinzufügen oder bearbeiten

Um einen neuen API-Schlüssel zu erstellen, klicken Sie in der Toolbar oben links auf Hinzufügen. Vergeben Sie eine Bezeichnung für den Schlüssel und legen Sie den sogenannten Scope fest, indem Sie auswählen, auf welche API-Endpunkte der Schlüssel zugreifen darf. Entscheiden Sie auch, ob die Quittierung für diesen API-Schlüssel einzeln oder allgemein durchgeführt werden soll (mehr Infos im folgenden Abschnitt).

Um die Bezeichnung oder den Scope für einen existierenden Schlüssel zu ändern, wählen Sie den API-Schlüssel in der Liste aus und klicken Sie oben in der Toolbar auf Bearbeiten.

Quittierung je API-Schlüssel

Bei der Erstellung bzw. Bearbeitung eines API-Schlüssels haben Sie die Möglichkeit, die Quittierung für den entsprechenden API-Schlüssel einzeln zu aktivieren. Bitte beachten Sie, dass die Aktivierung der einzelnen Quittierung nicht mehr rückgängig gemacht werden kann.

Um die Vorteile der Quittierung je API-Schlüssel zu nutzen, ist es eine Voraussetzung, dass Sie für jede über die API verbundene Anwendung auch einen separaten API-Schlüssel verwenden.

Hintergrund

Die Quittierung je API-Schlüssel bedeutet, dass bei Aktivierung für den jeweiligen Schlüssel ein eigenständiger Datenbestand mit dem Status von Quittierungen erzeugt wird. In diesem Fall wird z.B. bei Abruf eines Kontoumsatzes über die API der Kontoumsatz nur für diesen einzelnen API-Schlüssel als abgerufen markiert. Das ist sinnvoll, wenn Sie über verschiedene Applikationen über die API auf den Datenbestand Ihres Mandanten zugreifen, und die Daten in jeder Applikation separat vollständig sein sollen.

Sie können die Quittierung je API-Schlüssel bei Bedarf auch nur für manche API-Schlüssel aktivieren. Dann greifen die API-Schlüssel mit allgemeiner Quittierung weiterhin auf den allgemeinen, mandantenweiten Quittierungsstatus zu.

Beispiel: Sie nutzen zwei API-Schlüssel, um über konfipay sync und über Ihr ERP-System Kontoumsätze abzurufen. Wenn Sie die die Quittierung je API-Schlüssel nicht nutzen, wird der Kontoumsatz z.B. in konfipay sync abgerufen und danach quittiert. In diesem Fall gilt die Quittierung für alle Anwendungen welche Daten über die konfipay API beziehen. Wenn das ERP-System im Anschluss alle nicht quittierten Umsätze abrufen möchte, erhält es keine Daten mehr, da die Quittierungen von konfipay Sync im Vorfeld bereits gesetzt wurden.

Um ein solches Szenario zu vermeiden, kann in konfipay sync und in der ERP-Anwendung jeweils ein anderer API-Schlüssel verwendet werden, bei welchen die Quittierung je API-Schlüssel aktiviert wurde. Führt konfipay sync nun eine Quittierung durch, so ist diese an den API-Schlüssel gekoppelt und zählt auch nur für diesen. Das ERP-System wird somit nicht beeinflusst und kann die abgerufenen Datensätze selbstständig quittieren.

Dateitypen mit eigenem Quittierungsstatus

Für die nachfolgenden Dateitypen wird der Quittierungsstatus in konfipay protokolliert:

Aktivieren der Quittierung je API-Schlüssel

Wenn Sie die Quittierung je API-Schlüssel für einen API-Schlüssel aktivieren, müssen Sie auswählen, mit welchem Stand der Quittierungen sie die Option für den Schlüssel aktivieren möchten. Dieser Stand dient lediglich als Ausgangslage. Nach der Aktivierung ist der Stand der Quittierungen für diesen Schlüssel vom allgemeinen Stand entkoppelt. Sie haben folgende Optionen:

• Aktueller Stand → der Stand des mandantenweiten Quittierungsstatus wird übernommen, und für alle zukünftigen Datensätze wird der Abruf einzeln quittiert.

• Alle neu → alle vorliegenden Datensätze werden für den entsprechenden API-Schlüssel als “Nicht abgerufen”/”Neu” markiert.

• Alle abgerufen → alle vorliegenden Datensätze werden für den entsprechenden API-Schlüssel als “Abgerufen” markiert.

• Alle abgerufen bis → die vorliegenden Datensätze werden bis zu dem entsprechenden Datum für den entsprechenden API-Schlüssel als “Abgerufen” markiert, und alle späteren vorliegenden Datensätze werden als “Nicht abgerufen”/”Neu” markiert.

Bei der Aktivierung der Quittierung je API-Schlüssel wird der API-Schlüssel kurz deaktiviert, damit im Hintergrund der gewählte Stand der Quittierungen übernommen werden kann. Während dieser Zeit können Sie den API-Schlüssel nicht verwenden. Die Dauer schwankt je nach Größe des Datenbestands zwischen wenigen Sekunden und einigen Minuten.

Massenänderung des Quittierungsstatus für einzelne API-Schlüssel

Innerhalb der konfipay-Benutzeroberfläche können Sie nur für den allgemeinen, mandantenweiten Quittierungsstatus von Dateien Massenänderungen durchführen, aber nicht den für einzelne API-Schlüssel. Für einzelne API-Schlüssel können Sie den Quittierungsstatus nur für jede Datei einzeln verändern. Wenn eine Massenänderung des Quittierungsstatus für einzelne API-Schlüssel nötig sein sollte, kontaktieren Sie bitte unseren Support unter support@konfipay.de

Schlüssel deaktivieren oder löschen

Wenn Sie einen API-Schlüssel nicht mehr benötigen und sicherstellen wollen, dass er nicht mehr für Zugriffe genutzt werden können, können Sie den Schlüssel deaktivieren oder löschen. Eine Löschung ist permanent; ein deaktivierter Schlüssel kann zu einem späteren Zeitpunkt wieder aktiviert und wieder genutzt werden.

Um einen API-Schlüssel zu löschen bzw. zu deaktivieren, wählen Sie den Schlüssel in der Liste aus und klicken oben in der Toolbar auf Löschen bzw. Deaktivieren.

Schlüssel neu generieren

Sie können einen existierenden API-Schlüssel erneut generieren, indem Sie den Schlüssel in der Liste auswählen und oben in der Toolbar auf Neu generieren klicken. Dies hat zur Folge, dass der Schlüssel in allen Anwendungen, die ihn nutzen, neu hinterlegt werden muss, da der alte Schlüssel dann seine Gültigkeit verliert.

Einen API-Schlüssel neu zu generieren, ist vergleichbar mit einer Passwortänderung - das neue Passwort muss an allen Geräten dann neu eingegeben werden.