The ClientExec REST API allows developers to hook into ClientExec and connect it to third-party applications. Whether you’re writing a plugin for an application or planning on hooking some internal application into ClientExec, the API can do it for you.
The ClientExec API is implemented as plain XML or JSON over HTTP using all four REST commands – GET, POST, PUT and DELETE. Every resource, like Ticket, User or Invoice, has their own URL and are manipulated in isolation. The API closely follows the REST principles and it’s easy to use.
You can explore the GET part of the API through any browser. We recommend Firefox. Most URLs in ClientExec can be viewed in XML form by appending the URL with .xml such that /tickets/124 becomes /tickets/124.xml if you want to see the XML version of the ticket.
Use of the API is always through an existing admin user in your ClientExec installation. There’s no special API key. You get to see and work with what the admin you are logging in to the API is allowed to. You’re required to add user credentials via HTTP Basic Authentication. Security is provided via SSL if your ClientExec installation supports it, which is always recommended.