API communication
Info
Direct link: konfipay (DE) | konfipay (CH)
Navigation path: Client management > API > API communication
Quick navigation: API Kommunikation
User groups: Admin, Full access, Management
Required permissions: Show API communication/Show API communication details
General information
On this page, you will find a detailed log of API communication of the client. All accesses to the API are recorded here, i.e. it is possible to trace when which interaction of external applications with the API took place and whether this interaction was successful.
The overview shows not only the timestamp and API URL used, but also the HTTP request method used, the status code returned, and the server-side processing time. Users from the Admin and Full Access user groups can also view the API communication details.
Users from the Administration user group cannot view API communication details.
Overview page with HTTP request method used (1), status reported back (2),
and viewing the API communication details (3)
Filter logs
Furthermore there is a filter available to narrow down the content of the log. In addition to the date, it is also possible to filter on status codes, e.g. if only faulty interactions are of interest.
Date filter (1) and drop-down list for status filter (2)
If desired, API logging in the upper right part of the window can be deactivated. However, the lack of a log makes troubleshooting more difficult in the event of a problem. On the other hand, it also makes API accesses more performant, since logging takes time.
API communication details
Each individual log entry can be edited with 🔍 to be shown in detail. The communication process is discussed in more detail.
Detail | Content |
|---|---|
Timestamp | The exact time at which the communication took place |
Method | The HTTP request method sent to the confipay server. |
URL | The API URL used for the request |
Request header | The HTTP request headers set by the client |
Request Content | The HTTP Request Content transmitted by the client |
Response status | The status reported back by the server |
Response header | The HTTP response headers set by the server |
Response Content | The HTTP response content transferred from the server |