API-Kommunikation
Info
Direktlink: konfipay (DE) | konfipay (CH)
Navigationspfad: Mandantenverwaltung > API > API-Kommunikation
Schnellnavigation: API Kommunikation
Benutzergruppen: Admin, Vollzugriff, Verwaltung
Benötigte Berechtigungen: API-Kommunikation anzeigen/API-Kommunikationsdetails anzeigen
Allgemeine Informationen
Auf dieser Seite findet sich ein detailliertes Protokoll der API-Kommunikation des Mandanten. Alle Zugriffe auf die API werden hier mitgeschrieben, d.h. man kann nachvollziehen, wann welche Interaktion von externen Applikationen mit der API stattgefunden hat und ob diese Interaktion erfolgreich war.
Der Übersicht kann neben Zeitstempel und verwendeter API-URL auch die verwendete HTTP-Anfragemethode, den rückgemeldeten Statuscode und die serverseitige Verarbeitungszeit entnommen werden. Nutzer aus der Benutzergruppe Admin und Vollzugriff können außerdem die API-Kommunikationsdetails einsehen.
Nutzer aus der Benutzergruppe Verwaltung können API-Kommunikationsdetails nicht einsehen.
Übersichtsseite mit verwendeter HTTP-Anfragemethode (1), rückgemeldetem Status (2),
und Einsicht der API-Kommunikationsdetails (3)
Protokolle filtern
Des Weiteren steht ein Filter zur Verfügung, um den Inhalt des Protokolls einzugrenzen. Neben dem Datum kann auch auf Statuscodes gefiltert werden, wenn z.B. nur fehlerhafte Interaktionen gesucht sind.
Datumsfilter (1) und Drop-Down-Liste für Statusfilter (2)
Auf Wunsch kann die API-Protokollierung im rechten oberen Teil des Fensters deaktiviert werden, allerdings erschwert das Fehlen des Protokolls die Fehlersuche im Problemfall. Andererseits werden API-Zugriffe dadurch auch performanter, da die Protokollierung Zeit in Anspruch nimmt.
API-Kommunikationsdetails
Jeder einzelne Protokolleintrag lässt sich mit 🔍 noch detailliert anzeigen. Dabei wird genauer auf den Kommunikationsvorgang eingegangen.
Detail | Inhalt |
|---|---|
Zeitstempel | Die genaue Zeit, zu der die Kommunikation stattgefunden hat |
Methode | Die HTTP-Anfragemethode, die an den konfipay-Server gesendet wurde |
URL | Die verwendete API-URL für die Anfrage |
Request Header | Die vom Klienten gesetzten HTTP Request Header |
Request Content | Der vom Klienten übertragene HTTP Request Content |
Response Status | Der vom Server zurückgemeldete Status |
Response Header | Die vom Server gesetzten HTTP Response Header |
Response Content | Der vom Server übertagene HTTP Response Content |