README

Marketo REST API Client

Unofficial PHP client for the Marketo.com REST API: http://developers.marketo.com/documentation/rest/. Requires PHP 5.3.3+

Installation

The recommended way of installing the client is via Composer. Simply run the following command to add the library to your composer.json file.

composer require david-evans/marketo-rest-client

Setup

The client is built on Guzzle 3 and uses a factory method to create an instance. You must specify either a Munchkin ID or the full url.

####For Rest Api access:

use CSD\Marketo\Client;

$client = Client::factory(array(
    'client_id' => 'Marketo client ID',         // required
    'client_secret' => 'Marketo client secret', // required
    'munchkin_id' => '100-AEK-913' // alternatively, you can supply the full URL, e.g. 'url' => 'https://100-AEK-913.mktorest.com'
));

####For Bulk Api access:

use CSD\Marketo\Client;

$client = Client::factory(array(
    'client_id' => 'Marketo client ID',         // required
    'client_secret' => 'Marketo client secret', // required
    'munchkin_id' => '100-AEK-913' // alternatively, you can supply the full URL, e.g. 'url' => 'https://100-AEK-913.mktorest.com'
    'bulk' => true // if uploading leads via file upload (e.g. csv)
));

Usage

View the source of src/Client.php for all the available methods.

Contributing

Please create pull requests. Hopefully pull requests will be reviewed within a couple of days. In general don't merge your own pull requests. Operations will be available with just the addition of a the operation in the service.json file as long as you are using $client->getFoo()->getResult() but most of the operations have their own access methods with simplified argument handling. Operations do not need to have their own response class unless it does something special. Please respect semantic versioning in this project. That means no break in backwards compatibility unless a major version change is being planned.

Example of the simplest addition of a new operation:

{
    "operations": {
        "getFoo": {
            "httpMethod": "GET",
            "uri": "foo.json",
            "parameters": {},
            "responseModel": "baseResponse",
            "responseClass": "CSD\\Marketo\\Response"
        },
}

License

This source is licensed under an MIT License, see the LICENSE file for full details. If you use this code, it would be great to hear from you.

david-evans / marketo-rest-client

Maintainers

Details