eyefi/marketo

A PHP client for the Marketo SOAP API.

Marketo

A PHP client for the Marketo SOAP API., _(*1)

Installation

Add following line to your composer.json require:, _(*2)

``` json "eyefi/marketo": "dev-master", <sub>(*3)</sub>

And the following to you composer.json repositories:

``` json
{
  "type": "vcs",
  "url": "https://github.com/eyefi/marketo"
}

Usage

• get_lead_by
• sync_lead
• add_to_campaign
• get_campaigns

Authentication

The first thing you'll want to do is include the marketo class and create a new instance of the client., <sub>(*4)</sub>

You will need your SOAP user id and SOAP encryption key as well as the hostname for your Marketo API endpoint. These can be found in the Admin -> SOAP section when logged into app.marketo.com., <sub>(*5)</sub>

If you store configuration in the environment you would create a new instance like:, <sub>(*6)</sub>

``` php <?php use Marketo\Marketo; $marketo_client = new Marketo($_ENV['MARKETO_USER_ID'], $_ENV['MARKETO_ENCRYPTION_KEY'], $_ENV['MARKETO_SOAP_HOST']);, <sub>(*7)</sub>

The credentials are passed directly to the class rather than looking for constants or keys stored in superglobals so you can connect to multiple Marketo instances.

### Getting a lead

You can get a lead using the `get_lead_by($type, $value)` method.

**Arguments**

`$type` - The type of ID you would like to look up the lead by. This can be one of the following:

 - `idnum` - The Marketo lead ID
 - `cookie` - The entire _mkto_trk cookie
 - `email` - The email address of the lead
 - `sdfccontantid` - The Salesforce Contact ID
 - `sfdcleadid` - The Salesforce Lead ID

`$value` - The value for the key. For example if the $type is email the $value should be and email address

**Examples**

``` php
<?php
$marketo_client->get_lead_by('email', 'ben@benubois.com');

This will return an array of lead objects or FALSE if not found. The result will always be an array whether there are one or more leads found., <sub>(*8)</sub>

Creating or updating a lead

You can create or update a lead using the sync_lead($lead, $lead_key = NULL, $cookie = NULL) method., <sub>(*9)</sub>

Arguments, <sub>(*10)</sub>

$lead - Associative array of lead attributes, <sub>(*11)</sub>

$lead_key - Optional, The key being used to identify the lead, this can be either an email or Marketo ID, <sub>(*12)</sub>

$cookie - Optional, The entire _mkto_trk cookie the lead will be associated with, <sub>(*13)</sub>

Examples, <sub>(*14)</sub>

When no $lead_key or $cookie is given a new lead will be created, <sub>(*15)</sub>

``` php <?php $marketo_client->sync_lead(array('Email' => 'ben@benubois.com'));, <sub>(*16)</sub>

When a $lead_key or $cookie is specified, Marketo will attempt to identify the lead and update it. Sending the `_mkto_trk` cookie is important for associating the lead you're syncing with any information Marketo collected when the lead was anonymous.

``` php
<?php
$marketo_client->sync_lead(array('Unsubscribed' => FALSE), 'ben@benubois.com', $_COOKIE['_mkto_trk']);

This will return the updated or created lead object., <sub>(*17)</sub>

Adding leads to campaigns

You can add leads to a campaign using the add_to_campaign($campaign_key, $leads) method., <sub>(*18)</sub>

Arguments, <sub>(*19)</sub>

$campaign_key - Either the campaign id or the campaign name. You can get these from get_campaigns()., <sub>(*20)</sub>

$leads - An associative array with a key of lead id type and the corresponding value. This can also be an array of associative arrays. The available id types are:, <sub>(*21)</sub>

• idnum - The Marketo lead ID
• sdfccontantid - The Salesforce Contact ID
• sfdcleadid - The Salesforce Lead ID

Examples, <sub>(*22)</sub>

Add one lead to a campaign, <sub>(*23)</sub>

``` php <?php $client->add_to_campaign(321, array('idnum' => '123456'));, <sub>(*24)</sub>

Add multiple leads to a campaign with mixed id types

``` php
<?php
$leads = array(
   array('idnum' => '123456'),
   array('sfdcleadid' => '001d000000FXkBt')
);

$client->add_to_campaign(321, $leads);

Returns TRUE if successful FALSE if not, <sub>(*25)</sub>

Getting campaigns

You can get available campaigns using the get_campaigns($campaign = NULL) method., <sub>(*26)</sub>

Arguments, <sub>(*27)</sub>

$name - Optional, the exact name of the campaign to get, <sub>(*28)</sub>

You would usually use this to figure out what campaigns are available when calling add_to_campaign()., <sub>(*29)</sub>

Returns an object containing all the campaigns that are available to the API. Campaigns are only available to the API if they have a Campaign is Requested trigger where the Source is Web Service API., <sub>(*30)</sub>

Examples, <sub>(*31)</sub>

php <?php $marketo_client->get_campaigns();, <sub>(*32)</sub>