Versions Compared

Version Old Version 24 New Version 25
Changes made by

Collin Peters

Collin Peters

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The Connector is currently (as of April 2012) considered to be in version 1 complete.  This means that the system should be stable, but there will be missing features that are scheduled to be implemented in future stages (see appendix). Email me (Collin) if you encounter any issues. Thanks.
  • Currently (April 2012) there is no security (i.e. username/password) on the web service calls. 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 is not supported.  This will be added shortly

Introduction

In order to get your platform integrated with the Connector the following steps will occur

  • Agreement between InTouch and you on what level of functionality will be provided.  Note that in order for the Connector to support sending information to your system, it must support the necessary API calls, and work must be done to add support to the Connector to make those web service calls.
  • Support for the following options is available in the Connector
    • Data In (i.e. Your system making web service calls to the Connector)
      • Contacts (prospects and members) - the Connector has one call to save both prospects and members. There is a user_type field which is used to differentiate between the two.
      • Staff
      • Lead sources
    • Data Out (i.e. Connector making web services calls to your API)
      • Contacts
        • Creation of a prospect/member in your system when a prospect/member is added to the Connector from another system
        • Update of a prospect/member in your system when a prospect/member is updated in the Connector by another system
        • Note: Conversion of a prospect to a member is handled on a case-by-case basis
      • Staff - Note: Please see the section below on the staff synchronization process
      • Lead Sources - Note: Please see the section below on the lead source synchronization process
  • Connector is built using ReST web services and currently supports XML payloads. JSON might be supported in the future if requested.  
    • Note: When calling your web services the Connector will obviously use whatever technology is required
  • 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: Before actual web service calls can be made, work must be done in order to support your platform as per the details above.
    • Email cpeters@intouchfollowup.com to get set up. The process is that you will need to give us the club/location IDs on your side and we will match them to a test club/location in the InTouch system. Once that information has been entered into InTouch you can start making web service calls

...

Future Phases

Version 2

  • Security & SSL