REFTRACKER API Manual

What is the RefTracker API?

The RefTracker API provides a number of tools that allow custom interfaces to be built for your RefTracker system, when that is necessary.  Use of the API requires a programmer so the documentation provided by this manual is designed for use by programmers. 

The API provides a number of tools that are summarised in this page, that is also accessible for Logged in System administrators at System>Utilities>Information>API Methods:
http://<YourRefTrackerDomain>/exchange/api.asmx

Some things that you might use this API for include:

1. Pull Knowledge Base and Frequently Asked Questions out of the RefTracker database to insert into your own web pages – you can display search results and form links that would otherwise require users to visit your RefTracker site. You can take advantage of the JavaScript API to add a RefTracker Widget to an existing page or you can request XML and use the responses to build your own presentation layout. 
2. Submit a new question without displaying a RefTracker form or Question receipt confirmation screen, providing options to have questions submitted to RefTracker from other applications, or to design forms using features not available in the forms that can be created in RefTracker, such as radio buttons and multi-select tick boxes where the selected options can be sent to a single RefTracker text box or text area.
3. Retrieve information about an already existing question in RefTracker, so that it can be used by another application. 
4. Presenting data collected in RefTracker in graphs created by business information systems like Power BI.
5. Interfacing a large screen monitor showing just the jobs for a digitisation department, for example.

Securing your API usage:

Before using the API it is important that you consider security for its use.  See API use security for how to do this.

Who should use this manual?

Customer IT staff, who are implementing systems using the API can read this document as a stand-alone document.

System administrators should already have a thorough understanding of the RefTracker Client, Staff, Supervisor and Administrator training courses so they can assist with how the API can be used in conjunction with how they use their RefTracker system.

Where to obtain updated versions of this manual?

As new versions of RefTracker are released, updated versions of this manual, and all RefTracker training courses, are made available in the RefTracker help system and from the RefTracker support site at:
http://supportsite.altarama.com/app/RefTracker

If you would like to make a comment about how we can improve the next version of this manual, please send your comment to info@altarama.com.au.

Where to obtain assistance in relation to RefTracker?

A web site especially for RefTracker System Administrators is provided at the following address. At this site you can always obtain the latest information about RefTracker, and help with your project.
http://supportsite.altarama.com/app/RefTracker

For additional assistance contact Altarama:
Phone: +61 2 9974 2500 Sydney, Australia +1 888 982 9997 Utah, USA
Email: reftrackerhelp@altarama.com.au