The REST API can be used to access data and perform actions from external applications.
The current version of the API is v2
The default format of API responses is XML, but JSON and YAML are also available options. The URL needs to be adjusted as in the below example of listing all departments.
The hash parameter is created by the following function.
$time = time();
$hash = md5($rest_api_key . "@@@@" . $time);
Time and hash are required parameters for using the API.
Optionally, you can also use the staff_id
parameter, which refers to the ID of the operator using the API for logging purposes.