README

salesmachine-php is a library which allows you to easily send data from your PHP aplication to SalesMachine.IO. The library can be used right away without a complicated setup as shown in the examples below.

When using this library in a high traffic production environment you can use different options to optimize the behavior. See the chapter Usage in Production Environments and Options for more details.

Requirements

First off, you need to have an account at SalesMachine.IO and be in possession of valid API credentials. The requirements regarding your PHP environment are quite basic:

• PHP 5.x
• CURL module
• JSON module

Quick Guide and Code Examples

Installation

The salesmachine-php client library comes as a Composer package.

Init Salesmachine

Salesmachine::init($api_key, $api_secret, array('use_buffer' => true));

Create or Update a Contact

Salesmachine::set_contact($contact_uid, array('name' => 'John Doe', 'email' => 'john@doe.com'));

Track Pageview of a Contact

Salesmachine::track_pageview($contact_uid, array('/dashboard'));

Track Events of a Contact

Salesmachine::track_event($contact_uid, 'your event name');

Using salesmachine-php in Production Environments

While the default settings get you going right away, it is recommended to change some settings for production environments.

By default, all requests to SalesMachine.IO are with CURL in real time. On a high traffic environment this can eventually lead to reduced performance on the host site. It is therefore recommended to enable the option "use_buffer" which will buffer all requests to a local file first.

The local buffer can then be sent with a cron job in regular intervals by using the code below. This method ensures that the SalesMachine.IO library won't degrade the performance of the host environment.

Store a requests in local buffer

Salesmachine::init($api_key, $api_secret, array('use_buffer' => true));
Salesmachine::set_contact($contact_uid, array('name' => 'John Doe', 'email' => 'john@doe.com'));
...

Process local buffer in cron job

Salesmachine::init($api_key, $api_secret);
Salesmachine::flush();

Options

When calling Salesmachine::init($api_key, $api_secret) an array of options can be passed as a third parameter. If this parameter is not present or option keys are missing, the default values are taken.

Additional Information

For more information please visit

• http://salesmachine.io
• https://github.com/salesmachine-io/salesmachine-php