API Overview

The open API is a collection of RESTful web services that allow developers to connect to iHelpdesk service through simple HTTP requests.

Authentication

Uses HTTP basic authentication, and SSL is enabled for some accounts.

Response

Responses are in XML format.

Examples:

  • HTTP status code: 200:

    <tickets total="39">
         <ticket>
             <id>2180982138941289</id>
             <subject>my ticket</subject>
             <description>there is something wrong</description>
         </ticket>
         <ticket>
             <id>7839239452334523</id>
             <subject>ticket2</subject>
             <description>help</description>
         </ticket>
     </tickets>
    
  • Error case, HTTP status code 400:

    <errors>
         <error>
             <code>001</code>
             <msg>DocumentException</msg>
         </error>
         <error>
             <code>002</code>
             <msg>ParseException</msg>
         </error>
     </errors>
    

Testing

You can use a nice command line tool curl to test out the API.

Example:

curl -u joe@acme.com:joe http://www.ihelpdesk.com/desktop/api/acme/tickets