The record of requests and responses to the Admin API available in the IdoSell is a mechanism thanks to which, as a developer, you have the possibility of collecting real-time information regarding:

• date and time of beginning of execution of particular requests and their answers,
• date and time of end of execution of particular requests and their answers,
• the execution time of each query and its responses,
• the aggregated speed of each individual gateway,
• user-agent included in the HTTP header metadata of individual requests and their responses.

It is also a tool that will help you to check whether the API requests made by your programmes or scripts havethe correct structure required by a given gateway and whether they are processed correctly by it, and to identify and eliminate problems occurring in them at an early stage, ensuring their more optimal performance.

As a developer, it is therefore a must that you use it both when developing your own programmes or individual integrations and when optimising existing ones.

How to correctly configure the recording of any request and response and then proceed to analyse it?

Configuring request and response logging for a selected API

To enable recording of requests and responses to a selected API, go to the Administration / API / Access keys to Admin API page in the IdoSell administration panel, and then click the "[configure]" link next to the option Recording requests and responses to API in the section of the selected API.

The system will then show you a form where you can:

• indicate the user-agent included in the HTTP header metadata-you can select:
  • any user-agent registered in the statistics (option any: all),
  • user-agent of the selected IdoSell helper application (option any: name of the selected helper application),
  • user-agent of your own any application (option other),
• specify the duration (in seconds) of the listen-in - you can select from a minimum of 10 minutes (600 seconds option) to a maximum of 24 hours (86400 seconds option)

Analysis of requests and responses recorded at the selected API gateway

Each recorded request and response type is included in the speed report of the listed API gateways in the form of separately stored files. In addition, details of the aggregate speed of the gateways executed, the date, time and execution time of the registered requests and responses, and the UAString (user-agent) identifiers contained in the metadata of their HTTP headers are also recorded.

Due to the possibility of recording large amounts of data, which can have a real impact on the performance of both the report itself (extended data rendering time) and your shops (slower performance resulting from additional load on the server resources), we suggest that you choose the time after which the set recording of requests and responses to the API is completed with caution.

From a performance point of view, the optimum solution we recommend is to perform more frequent registrations with a shorter running time concerning only the gateways you are interested in and to download their saved logs.

The ability to download logs will be available to you for a period of one month from the date the last logging ended or until the next logging starts. After this time, the data collected during the last logging will be permanently deleted by the system.