...
This document describes the Connector web service API. This document assumes you know what the Connector is and does not include an overview of it (please see “Connector – Overview.pdf”)
| Info | ||
|---|---|---|
| ||
This document describes the Connector API which is used for INCOMING data. That is data that is coming from your platform and going to other platforms, via the Connector. If the integration agreement that you have decided upon with InTouch is only for outgoing data (that is, your system only receives data) then this document does not apply. Please see the companion document "Connector 3rd Party Partner Integration Guide" for details on receiving data. |
...
- Currently (April 2012) there is no security (i.e. username/password) on the Connector web service API calls made to the Connector. This will obviously change soon but for now it is simply ‘security through obscurity’ in the sense that the GUIDs provide a level of security because they effectively cannot be guessed
- Currently (April 2012) SSL/HTTPS does not exist on the Connector web service API calls. This will be added in the next release of the Connector
- A Java library is available to communicate with Connector to ease your development should you be a Java shop
- Our QA environment which you can use to develop against is http://qa.intouchfollowup.com/connector/api/2011-11/user. Note that before actual web service calls can be made, work must be done by InTouch in order to make it aware of your platform
...
The Connector is built on the concept of one fitness club (i.e. one physical location) belonging to one client. One client may have many clubs (i.e. a 10 location chain). All of the entities that the Connector works with (prospects, members, staff, lead sources) must belong to one client, and one club within that client. It is important to note that all communication with the Connector is done using the IDs from YOUR SYSTEM. While you can track the GUIDs that the Connector returns to you, you should not communicate with the Connector using these GUIDs. Think of this way, when you make a call to the Connector you are saying: I am 'PROVIDER XPARTNER X', here is a prospect record that has the ID 123456 in my system, and it belongs to club 123 within the client 456.
...