Versions Compared

Key

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

...

  • Connector is built using ReST web services and currently supports XML payloads. JSON might be supported in the future if requested.  
  • A Java library is available to communicate with Connector to ease your development should you be a Java shop
  • Currently, the available service is for saving and fetching users, and retrieving a list of staffThe URL for the user service is web services are
    • User services - GET operation to fetch a user, POST operation to save (create/update) a user.   URL: http://<domain>/connector/api/2011-11/user. It supports a
    • Staff services - GET operation to fetch a list of staff.  URL: http://<domain>/connector/api/2011-11/staff
    • Lead source services - GET operation to retrieve fetch a userlead source, and a POST operation to save a userThe URL for the staff service is http(create/update) a lead source.  URL: http://<domain>/connector/api/2011-11/staff. It supports a GET operation to retrieve the list of staffleadsource
  • Our QA environment which you can use to develop against is http://qa.intouchfollowup.com/connector/api/2011-11/user
  • 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

Getting Started

In order to get your system integrated with the Connector the following steps must occur

  1. Prospects - Your API must implement the following methods in order to allow the Connector to create prospects
    1. Create prospect
    2. Update prospect
    3. Note: A single 'Save prospect' method is also acceptable
  2. Members - Your API must implement the following methods in order to allow the Connector to create members
    1. Create member
    2. Update member
    3. Note: A single 'Save member' method is also acceptable
    4. Note: The process of converting a prospect to a member is unique per system. 
  3. Staff - Your API must implement the following methods in order for the Connector to sync staff 
    1. Fetch list of staff - The email address must be accessible in order for the Connector to associate certain records together
    2. Create staff
    3. Update staff
  4. Lead Sources - Your API must implement the following methods in order for the Connector to sync lead sources
    1. Fetch list of lead sources
    2. Create lead source
    3. Update lead source

Technical Discussion

Working With User Records

...