...
- This document will outline the steps necessary to integrate get your platform integrated with the Connector platform, which will allow instant an easy integration with multiple other 3rd-party platforms with no additional effort.
- This document assumes the user knows what Connector is does not include an overview of it (please see or request “Connector – Overview.docx”)
...
- The Connector is currently (as of April 2012) considered to be in stage 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. 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
...
Introduction
In order to get your platform integrated with the Connector the following steps will occur
- Agreement between parties on what functionality will be provided. Support for the following options is available
- Prospects
- Creation of a prospect in your system when a prospect is added to the Connector from another system
- Update of a prospect in your system when a prospect is updated in the Connector by another system
- Staff
- Lead Sources
- Prospects
- 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 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
- Staff services - GET operation to fetch a list of staff. URL: http://<domain>/connector/api/2011-11/staff
- Lead source services - GET operation to fetch a lead source, POST operation to save (create/update) a lead source. URL: http://<domain>/connector/api/2011-11/leadsource
- 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
...