Date: June 8, 2011
Last Updated: May 7, 2012
Contributors: No contributors found for: authors on selected page(s)
About
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 is agreed upon, you will require either one or both
- Connector 3rd Party 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 if you plan on sending data to the Connector (i.e. users created in your system are sent to InTouch)
Integration Options
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 extremely important as it has large implications on what the technical requirements will be.
The main questions that need answering are
- 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.
- What data is going to be included?
- Prospects (a.k.a. leads)
- Or Members
- Or both
- If doing prospects, is any additional data included
- Staff Owner of Lead
- Lead Source of Lead
General Information
This section outlines some common information about the Connector.