API Overview

An Application Program Interface (API) for adding records to a workgroup is available as an add-on feature for NetResults Tracker. This interface can be used as a gateway from an external application to NetResults Tracker. The client interface software, documentation, and sample code necessary to use the API are included in the NetResults Tracker Software Development Kit (SDK).

The API is implemented in two parts: a client interface (COM object) which is used by the external application, and the NetResults Tracker server (standard NetResults Tracker installation with the API feature enabled). The client and server components communicate via the Simple Object Access Protocol (SOAP) protocol which is implemented using XML over a HTTP (or HTTPS) connection. Since the client interface is implemented as a standard COM object, virtually any programming language can be used to write the external application (JavaScript, Visual Basic, C++, etc.). Since the standard HTTP/HTTPS protocol is used for communications between the external application (client) and NetResults Tracker (server), you can leverage your existing web security (firewall, SSL encryption, web server authentication, etc.).

The requirements for using the API as well as the steps to enable use of the API are included below. For information about the properties and methods available, please review the Properties and Methods Help section.

Simple Object Access Protocol (SOAP) is used as a means of communication between NetResults Tracker and the external application using the Add API to create new records. As such, the Add API requires several SOAP related components to be installed on the NetResults Tracker server (web server machine on which NetResults Tracker is installed) and the client (the machine with the external application). The required components for server and client are listed below.

NetResults Tracker Server Requirements

• NetResults Tracker 6.0.0
  NetResults Tracker Standard Edition or Enterprise Edition version 6.0.0 (or a subsequent maintenance release such as 6.0.1, 6.0.2, etc.) is required for use of the SDK.

• Operating System
  Windows Server 2003 or Windows 2000 Server with Service Pack 4 is required for use of the Add API.

• SOAP Interface
  Microsoft SOAP Toolkit 3.0 must be installed on the machine where NetResults Tracker is installed. To download this component, browse to the NetResults Tracker General Downloads Page.

  Microsoft WinHTTP 5.1 and Microsoft XML Core Services (MSXML) 4.0 are included when SOAP Toolkit 3.0 is installed.

• Windows Installer
  Windows Installer 2.0 or later is required to install SOAP. If you have Windows Server 2003 or Windows 2000 Server with Service Pack 3 or newer, you already have Windows Installer 2.0 installed. When installing SOAP, you will be prompted if you do not have the appropriate Windows Installer version. To download this component if needed, browse to the Microsoft Windows Installer 2.0 Download Page for Windows 2000.

• Browser
  Internet Explorer 5.0 or newer is required for installation of Microsoft SOAP Toolkit 3.0. To download the latest version of Internet Explorer, browse to the Microsoft Internet Explorer Download Page.

Client Requirements

If the external application is located on the same machine where NetResults Tracker is installed, the only additional requirement beyond the NetResults Tracker Server Requirements listed above is the installation of the SDK itself. Otherwise, all requirements listed below must be met.

• NetResults Tracker SDK 6.0.0
  The NetResults Tracker SDK version 6.0.0 must be installed on the same machine as the client application which will use the API to communicate with the NetResults Tracker Server. It does not need to be installed on the NetResults Tracker Server machine.

• Operating System
  Any of the following operating systems may be used on the client:
  • Windows Server 2003
  • Windows XP
  • Windows 2000 Server with Service Pack 4 or newer
  • Windows NT 4.0 with Service Pack 6 or newer

• SOAP Interface
  Microsoft SOAP Toolkit 3.0 must be installed on the machine where the external application resides. To download this component, browse to the NetResults Tracker General Downloads Page.

  When installing the SOAP Toolkit on the client machine only the following components are required to be installed:

  • ISAPI Listener
  • Microsoft XML Parser

  Microsoft WinHTTP 5.1 and Microsoft XML Core Services (MSXML) 4.0 are included when SOAP Toolkit 3.0 is installed.

• Windows Installer
  Windows Installer 2.0 or later is required to install SOAP. If you have Windows Server 2003 or Windows 2000 with Service Pack 3 or newer, you already have Windows Installer 2.0 installed. When installing SOAP, you will be prompted if you do not have the appropriate Windows Installer version. To download this component if needed, browse to the Microsoft Windows Installer 2.0 Download Page for Windows NT and 2000.

• Browser
  Internet Explorer 5.0 or newer is required for installation of Microsoft SOAP Toolkit 3.0. To download the latest version of Internet Explorer, browse to the Microsoft Internet Explorer Download Page.

Perform the following steps to enable the Add API feature:

Install Required Components

• Install the required components on the NetResults Tracker server as mentioned in the Server Requirements section above.
• Install the required components on the client as mentioned in the Client Requirements section above.

Enter the API license key into the NetResults Tracker License Manager
You must enter a license key into the License Manager on the NetResults Tracker Server in order to use the Add API feature.

Enable the Add API option in General Preferences
For each workgroup where the Add API will be used:

1. Login to the workgroup as Admin.
2. Click on the Admin icon.
3. Click on the General Preferences button.
4. Set the "Enable API" option to Yes.
5. Select a user for the option called "API User". If you select "Set From API" option, then a valid user must be supplied using "IdentityUser" property when using the API from the client. The user selected (or supplied) will determine the settings used when a record is created via the API. These settings include the privileges and field visibility granted to this user based on group membership. If you do not know which API User to select, we recommend selecting Admin (the default).
6. Click OK to save this change.