[Craig Brass]

Currently, there are two ways to integrate a piece of software with Kayako. The first is a LoginShare which has always been found to confuse the user unless you skin your Kayako installation to look exactly like your main site. It is also confusing as they must login again regardless of if they have already logged into your main site.

The second way is by including Kayako's core files and integrating in a similar way to how ModernBill and WHMCS do. There are a number of problems in doing this. The first is you require access to swift.php and functions.php which are both encoded files and you must decode these using a decoding service before you can edit them. The second is that your templates then become a maze of If and Else statements to say if the interface is your integration, show this. The final issue is that it stops you really being able to upgrade Kayako.

Our solution to this problem has been to write an API with an optional SOAP interface that you can have your main site software (CMS, etc) connect to to get the information it needs (Knowledge Base Categories and Articles, and Tickets). All that you need to do to install this API is to upload it to your Kayako folder on your server which means it doesn't stop you from upgrading Kayako in the future.

We provide this Integration API free of charge. If you wish to build this into an application that you are providing free or commercially, we require you to contact us first for permission (we won't charge you, we just require being contacted first) using <a href="http://www.craigbrasssystems.com/contact_form/index.html" target="_blank">our contact form</a>.

You can download the API by clicking the download link below. More information on setting it up and functions can be found in our <a href="http://www.craigbrasssystems.com/forum/index.php?showforum=63" target="_blank">Kayako Integration API forum</a>. You can also use this board to post any questions you may have and to report any bugs you find.

Both of the below archives contain the same files, but two different archive formats are provided for convenience. For Windows users, the .zip file is probably preferred, while Linux users will likely prefer the .tar.gz file.

Attached File(s)

•  Integration_API_1.0.9.zip (160.14K)
  Number of downloads: 158
•  Integration_API_1.0.9.tar.gz (150.44K)
  Number of downloads: 44

[Craig Brass]

Confirmed working in 3.30.00.

[Andrew Gillard]

Updated to version 1.0.1:

• Fixed a bug in the SOAP interface when using PHP's native SOAP client (thanks to DaviXX).

This post has been edited by Andrew Gillard: 07 September 2009 - 11:06 AM
Reason for edit: Fixing IPB 2 code

[Andrew Gillard]

Updated to version 1.0.2:

• Added a new function, getSubmittedTicketsWithExtraRestrictions(), that can be used as a replacement for getSubmittedTickets(). This new function allows the fetched tickets to be restricted to a specific start date range, a specific last activity date range, a specific due date range, a specific department, a specific status or a specific priority (thanks to moosarka).
  
• The view count of knowledge base articles will be updated when the getKnowledgeBaseArticle() function is called (thanks to Matt).

This post has been edited by Andrew Gillard: 07 September 2009 - 11:08 AM
Reason for edit: Fixing IPB 2 code

[Andrew Gillard]

Updated to version 1.0.3:

• Reverted the behaviour that fixed the problem with PHP's native SOAP client because it was breaking other clients, such as the .NET SOAP client (thanks to Guilherme).
  
• The workaround for PHP's native SOAP client is now optional behaviour, invoked by passing "phpcompat" as a GET argument to the WSDL URL (e.g. use http://www.example.com/helpdesk/integrationapi/index.php?wsdl&phpcompat instead of http://www.example.com/helpdesk/integrationapi/index.php?wsdl).

This post has been edited by Andrew Gillard: 07 September 2009 - 11:11 AM
Reason for edit: Fixing IPB 2 code

[Andrew Gillard]

Updated to version 1.0.4:

• Fixed a bug that caused the "send autoresponse" option to always be TRUE in the submitTicket() function (thanks to RandyJohnson).

This post has been edited by Andrew Gillard: 07 September 2009 - 11:11 AM
Reason for edit: Fixing IPB 2 code

[Andrew Gillard]

Updated to version 1.0.5:

• The API now supports submitting custom fields with new tickets, changing existing tickets' custom field values and retrieving custom field values of existing tickets. Please see the function documentation for more information:
  
  • getDepartmentCustomFields()
    
  • getSubmittedTicket()
    
  • submitTicket()
    
  • setCustomFieldValue()

This post has been edited by Andrew Gillard: 07 September 2009 - 11:13 AM
Reason for edit: Fixing IPB 2 code

[Andrew Gillard]

Updated to version 1.0.6:

• Fixed a bug that prevented tickets being submitted to departments which didn't have custom fields. (Additionally, the getDepartmentCustomFields() method will now return an empty array instead of NULL if the specified category has no custom fields)

This post has been edited by Andrew Gillard: 07 September 2009 - 11:30 AM
Reason for edit: Fixing IPB 2 code

[Andrew Gillard]

Updated to 1.0.7:

• Fixed a bug in the submitTicket() method that caused the $sendAuto argument to always be considered to be TRUE (thanks to dylan.lindgren).

This post has been edited by Andrew Gillard: 07 September 2009 - 11:31 AM
Reason for edit: Fixing IPB 2 code

[Andrew Gillard]

Updated to 1.0.8:

• Ticket count now gets updated when a ticket is submitted or updated (thanks to NickH).

[Andrew Gillard]

Updated to 1.0.9:

• Fixed a SQL injection vulnerability in the setCustomFieldValue() method (thanks to martin_boy).