REST API

The REST API can be used to access data and perform actions from external applications.

Current Version

The current version of the API is v2.

Multiple Formats

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.

http://mydomain.com/api/v2/Tickets/Department/?time=<time>&hash=<hash>
http://mydomain.com/api/v2/Tickets/Department.json/?time=<time>&hash=<hash>
http://mydomain.com/api/v2/Tickets/Department.xml/?time=<time>&hash=<hash>
http://mydomain.com/api/v2/Tickets/Department.yaml/?time=<time>&hash=<hash>

Authentication

The hash parameter is created by the following function.

$hash = md5($rest_api_key . '@@@@' . time());

Time and hash are required parameters for using the API.

Logging

Optionally, you can also use the staff_id parameter, which refers to the ID of the operator using the API for logging purposes.