mercurial/mailchimpv3

Mailchimp API V3 API Wrapper for Laravel 4

dev-master 2016-08-03 09:29 UTC

Requires

• php: >=5.4.0
• guzzlehttp/guzzle: ~5.3
• illuminate/support: 4.2.*

MIT

• Alberto Sanz Redondo
• Clark Alesna

• php
• mailchimp
• api
• laravel
• v3

README

• Installation
• Usage
  • Pagination
  • Filtering
  • Partial Response
  • Behind Proxy
• Examples
  • Collection object

Installation

Add the following to your composer.json

{
    "require": {
        "mercurial/mailchimpv3": "dev-master"
    }
}

Add ServiceProvider in your app.php config file.

// config/app.php
'providers' => [
    ...
    'Asanzred\Mailchimpv3\Mailchimpv3ServiceProvider'
]

and instead on aliases

// config/app.php
'aliases' => [
    ...
    'Mailchimpv3' => 'Asanzred\Mailchimpv3\Facades\Mailchimpv3'
]

Configuration

Publish the config by running:

php artisan config:publish asanzred/mailchimpv3

Now, the config file will be located under config/asanzred/mailchimpv3/config.php:

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Mailchimp API key
    |--------------------------------------------------------------------------
    |
    | To obtain an API key, go to mailchimp.com under your profile
    | you will find Extras -> API keys. Paste the key below.
    |
    */
    'apikey' => ''
];

Usage

There's only one method:

request($resource, $arguments = [], $method = 'GET') 

You can make these calls if needed

get($resource, array $options = [])
head($resource, array $options = [])
put($resource, array $options = [])
post($resource, array $options = [])
patch($resource, array $options = [])
delete($resource, array $options = [])

Pagination

We use offset and count in the query string to paginate data, because it provides greater control over how you view your data. Offset defaults to 0, so if you use offset=1, you'll miss the first element in the dataset. Count defaults to 10.

Source: http://kb.mailchimp.com/api/article/api-3-overview

Filtering

Most endpoints don't currently support filtering, but we plan to add these capabilities over time. Schemas will tell you which collections can be filtered, and what to include in your query string.

Source: http://kb.mailchimp.com/api/article/api-3-overview

Partial Response

To cut down on data transfers, pass a comma separated list of fields to include or exclude from a certain response in the query string. The parameters fields and exclude_fields are mutually exclusive and will throw an error if a field isn't valid in your request.

Source: http://kb.mailchimp.com/api/article/api-3-overview

Behind Proxy

If you are behind a proxy, you can use setProxy directly on the class.

setProxy(host : string, port : int, [ssl : bool = false], [username = null], [password = null]);

Examples

Collection object

All queries will return an instance of the Illuminate\Support\Collection object, which is really easy to work with. If you don't want to use the Collection object however, you can transform it into an array using $result->toArray().

$resource = '/lists/'

$result = Mailchimpv3::request($resource, $opts,'GET');

// Returns object(Illuminate\Support\Collection)
var_dump($result);

// Returns the first item
var_dump($result->first());

// Returns 3 items
var_dump($result->take(3));

// Returns a JSON string
var_dump($result->toJson());

// Returns an array
var_dump($result->toArray());