Search
Close this search box.
Search
Close this search box.
Search
Close this search box.

< / >

APIs Information

1. Monitoring Audit Logs

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=audit_log&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This API allows for a report of all the movements that have been made on the module, along with the date on which the change or request was made, the public IP, user, workplace and movement that was carried out.

Benefit:

By knowing all the changes that have been made on the module, it is possible to identify errors such as in routing or if any service with additional cost was activated, among others.

how it works:

  • Consuming this API is done via the GET method.
  • To consume this API you must replace {{wolkvox_server}} in the url with the server nomenclature of the operation.
  • The wolkvoxtoken header must be used to make use of the authorization token.
  • Be aware that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.
  • In terms of time, to track your operation you can make a consumption every 5 minutes of the information.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME DESCRIPTION TYPE
api Type of report required String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
date Date and time at which the action took place String
ip Public IP from where the action took place String
user Manager user who performed the action String
action Description of the action taken String
workstation Name of the workstation from where the action was taken String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=audit_log&date_ini={{date_ini}}&date_end={{date_end}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "date": "",
            "ip": "",
            "user": "",
            "action": "",
            "workstation": ""
        }
    ]
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data