Versions Compared

Version Old Version 25 New Version 26
Changes made by

Collin Peters (Unlicensed)

Collin Peters (Unlicensed)

Saved on

Key

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

...

  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 See below for notes on staff synchronization
    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

...

The solution of how the Connector attempts to overcome these issues is as follows:
  • At minimum you Your API must provide a call to get a list of staff
  • The Connector will make a call to fetch the list of all staff, and then attempt to make a match on the email address.
  • If there is no match, and there is a web service call to create staff, then the staff will be createdWhy this way?  This method the Connector cannot make a match on email address, then the look up fails.  Any leads created that are assigned to the failed staff will be sent to your system with no staff assigned.  Your system must be able to handle receiving leads that do not have an owner
  • Why this way?  This method has the lowest possibilities for errors.

...

Code Block
titleLead Web Service URL
http://<domain>/connector/api/2011-11/leadsource

Synchronizing Lead Sources

Synchronizing lead sources is very similar to synchronizing staff except if there is the ability to create a lead source, the Connector will use it.

The solution of how the Connector attempts to overcome these issues is as follows:

  • Your API must provide a call to get a list of lead sources
  • The Connector will make a call to fetch the list of all lead sources, and then attempt to make a match on the lead source name. The comparison will be case in-sensitive.
  • If the Connector cannot make a match on name, then the look up fails.  
    • If your API provides a method to create a lead source, the Connector will then make a call to create the lead source in your system
    • If your API does not provide a method to create a lead source, then any leads created that are assigned to that failed lead source will be sent to your system with no lead source assigned.  Your system must be able to handle receiving leads that do not have a lead source

Save Lead Source

Code Block
languagehtml/xml
titleRequest
<leadSource>
   <providerInfo>
      <identifier>PROVIDER_ID</identifier>
      <clientID>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</clientID>
      <clubID>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</clubID>
      <recordID>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</recordID>
   </providerInfo>
   <leadInfo>
      <name>Facebook</name>
      <active>true</active>
   </leadInfo>
</leadSource>

...