wildsurfer/infusionsoft-sync

v0.2.1 2014-11-27 18:40 UTC

This package is not auto-updated.

Last update: 2024-04-23 00:07:07 UTC


README

Use this library to add two-way syncing between your application and Infusionsoft CRM.

Features

  • Configure field names
  • Using custom field names if necessary
  • Configure tag names
  • Optimized to work with big data sets

How it works

This library realizes 2 methods to help to sync your application with Infusionsoft API: pull() and push()

pull() goes to remote API, fetches all contacts and returns them to you. You can then use this data to sync it with your application storage

push() will allow you to put your local users to remote. This method is smart enought to update contacts if they're already present at Infusionsoft and to skip if nothing was changed.

Under the hood there is a pull() method call inside the push() method. This is done to minify amount of API calls and to speed-up the process on big data sets. However when you push one contact pull() is skipped to prevent redundancy.

Examples

To get list of contacts from Infusionsoft API

<?php
use Wildsurfer\Infusionsoft;

$options = array(
    'appname' => 'myappname',
    'apikey' => 'asdU234YGUYG1234gjhg',
    'tags' => array(
        '1',
        '2',
        '3'
    ),
    'fields' = array(
        'Email',
        'FirstName',
        'LastName'
    )
);

$sync = new Sync($options);

$infusionsoftContacts = $sync->pull();

To push your application users to Infusionsoft API

<?php

$myUsers = ... // Fetch data from your storage

$toBeSyncedUsers = new ContactCollection();

foreach($myUsers as $user) {
    $array = someFunctionToMapYourFieldNamesToInfusionsoftFieldNames($user);
    $toBeSyncedUsers->create(new Contact($array));
}

$result = $sync->push($toBeSyncedUsers);

$created = $result['create']->read(); // Array of created contacts
$updated = $result['update']->read(); // Array of updated contacts
$failed = $result['fail']->read(); // Array of failed contacts
$skipped = $result['skip']->read(); // Array of skipped contacts

Displaying errors

<?php

$result = $sync->push(...);

$failed = $result['fail']; // Array of failed contacts

if ($failed->count() > 0) {
    foreach ($failed->read() as $f) {
        echo $f->getErrorMessage();
    }
}

Install with Composer

  {
      require: {
          "wildsurfer/infusionsoft": "dev-master"
      }
  }

Running tests

Tests that written for this library are splitted in two testsuites: unit and functional. To run functional tests you will need to setup Infusionsoft sandbox account and find your appname and apikey.

More info:

https://developer.infusionsoft.com/sandbox_application

http://ug.infusionsoft.com/article/AA-00442/0/Infusionsoft-API-Key.html

$ cp infusionsoft.ini.dist infusionsoft.ini
$ vim infusionsoft.ini