RefTracker API Widgets
You can use the information on this page to include content from RefTracker in your organisation’s webpages or to customize one of our pre-built layouts that can be included in your webpages. It provides a simplified way to use some of the features of the API.
API Widgets are not available for all of the available API functions (click here to see all API functions).
An important note about security: For simplicity, these examples presume that the appropriate API method has been enabled in the 9.x parameters, and that a key has NOT been set for them (as might be the case for implementation in a secure in-house environment). If you are implementing in an open environment, please ensure that you set APIkeys and include them in all calls, in order to ensure that the API methods that you enable, can ONLY be used by authorised users.
Widget API rewritten as jQuery Plugin
This Widget functionality uses a very different structure than previous API widget interaction, so please take the time to review it’s functionality. This has no bearing or impact on any of the API calls that can be made with your RefTracker system. These API Widgets provide a simplified solution for retrieving results from your RefTracker instance; it can certainly be added to, or, used as a template for a customized project. Please contact your RefTracker support person should you need clarification or additional instructions beyond these instructions.
These Widget APIs have been rebuilt as jQuery plugins. Access begins with the following two calls, preferably made as the page loads. The first script loads jQuery from a Google CDN, and the next script is invoking the Widget API page (not loaded anywhere else within RefTracker):
jQuery from Google
| 123456789 | // Any jQuery repository will work, depending on your specific needs - v 1.4+><script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js" type="text/javascript"></script> // Call the RefTracker API Search Widget// Change YOUR_REFTRACKER_URL to your RefTracker URL instance<script src="http://YOUR_REFTRACKER_URL/exchange/widget/js/reftrackerapi.js" type="text/javascript"></script> |
Where YOUR_REFTRACKER_URL is replaced with just the domain name of your RefTracker instance.
This widget API allows you to display RefTracker forms, categories, code tables and provides a simple Search form of selected questions within your system. Please refer to the documentation specifically geared to that API for additional details.
Once the above two files have been included, you can use any of the API widgets below: