Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Date:               June 8, 2011

Last Updated: May 7, 2012

Contributors:          

Table Of Contents

Introduction

This document describes the steps necessary to receive data from the Connector.  This document assumes you know what the Connector is and does not include an overview of it (please see “Connector – Overview.pdf”)

 

Important

This document describes the options available for the Connector making web service calls to your platform (i.e. you are the RECEIVER of data). That is, data which is coming from other platforms such as InTouch, going into your platform. If the integration agreement that you have decided upon with InTouch is only for sending data (that is, your system only sends data) then this document does not apply. Please see the companion document "Connector API Guide" for details on sending data.

First off, your system MUST provide some type of web services via an API that the Connector can call.  The required calls in order to support integration are listed below.  Once baseline features are agreed upon, work will need to be completed by InTouch in order to add support to the Connector to make API calls to your system.  When calling your web services the Connector will obviously use whatever technology is required (e.g. soap, rest, etc...).  Note that the Connector is a Java application, if you have a Java library already prepared that you can provide to InTouch it will greatly simply the work required on our part to make calls to your web service

Requirements

These are the web service calls required by your API in order for the Connector to sending data to your system

  1. Prospects - API calls required
    1. Create a prospect
    2. Update a prospect
    3. Note: A single 'Save prospect' method is also acceptable
  2. Members - API calls required
    1. Create a member
    2. Update a 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 Owner for prospects - API calls required
    1. Fetch list of staff - The email address must be accessible in order for the Connector to associate certain records together
    2. Notes
      1. Staff owner is optional. If staff owner for prospects is not supported then it is up to your system to handle this scenario  
      2. See below for details on staff synchronization.  
      3. The Connector does NOT attempt to create or update staff in any system due to the high level of complexity and overhead of creating staff (i.e. permissions, existing staff, etc...)
  4. Lead Sources - When receiving prospects, the lead source can optionally be included.  
    1. API calls required
      1. Fetch list of lead sources
      2. Create lead source
      3. Update lead source
    2. Note: See below for details on lead source synchronization

Turnup

This section details what is necessary to get a new client turned-up on the Connector.  The turn-up process for your system may vary slightly from other systems if there are any custom configuration options.

General Information required

  • The client ID number in your system
  • The club ID numbers in your system (1 for every club)
  • Connection information (not required for integrations with full SaaS platforms)
    • IP
    • Username/Password
    • Scheme (http/s)
  • Any custom configuration options built into the Connector for your platform

 

  • No labels