Versions Compared

Version Old Version 50 New Version 51
Changes made by

Collin Peters

Collin Peters

Saved on

Key

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

...

This document will outline the steps necessary to get your platform integrated with the Connector platform, which will 'connect' your platform with InTouch and multiple other 3rd-party platforms with no additional effort.  This document assumes you know what the Connector is and does not include an overview of it, please see the companion document "Connector – Overview.pdf" for an overview.

There are two sub-documents within this guide.  Based on the features of the integration that are agreed upon, you will require either one or both

  • Connector Partner Integration Guide - This guide is required if you plan on receiving data from the Connector.  This is the most common use case (i.e. users created in InTouch are sent to your system)
  • Connector API Guide - This guide is required only if you plan on sending data to the Connector (i.e. users created in your system are sent to InTouch)

Integration Options

 

Info
titleIMPORTANT

Before any technical details can be discussed, there needs be agreement on what level of functionality will be provided in the integration between InTouch and your system via the Connector.   This

is

is extremely

important

 important as it has large implications on what the technical requirements will be.  You should not proceed further without a detailed work plan of what is to be built

 

The main questions that need answering arerequire an answer

  1. Is the integration going be a two way synchronization, or one way?  i.e. will you be receiving data, sending data, or both.  The most common and simple integration is usually one-way where users created in InTouch are automatically created in your system. 
    1. If you will be receiving data, then you will need the 'Conenctor Partner Integration Guide'
    2. If you will be sending data, then you will need the 'Connector API Guide'
  2. What data is going to be included?
    1. Prospects (a.k.a. leads) 
    2. Or MembersOr both
    3. Ex/Former members
  3. If prospects, is any additional data to be included?
    1. Staff Owner of Lead
    2. Lead Source of Lead
    3. Trial information

Depending on your answers to steps 2 and 3, various requirements will need to be met.  For For example, if you wish to receive prospects with a staff owner, your web service must provide a method for the Connector to get a list of staff.  The details of these requirements are outlined in the companion documents

...