nblakefriend/mailchimp-apiv3

Complete PHP Wrapper for MailChimp API v3.0.

MailChimp API v3.0 PHP Wrapper

DEPRECATED:

This project is no longer maintained and is honestly not good. MC offers official 3.0 libraries now: mailchimp.com/developer, _(*1)

PHP wrapper for the MailChimp API v 3.0., _(*2)

Dependencies

• GuzzleHttp
• PHP > 5.4

Project still in the works. More documentation to come, _(*3)

Installing

Using Composer: composer require nblakefriend/mailchimp-apiv3, _(*4)

Getting Started

When downloading from composer (recommended): 1. In vendor/nblakefriend/mailchimp-apiv3/src create config.ini file with structure:, _(*5)

[api_keys]
key1[api_keys] = "yourmcapikey-usx"
key1[active] = true

Multiple accounts can be configured in this config file., _(*6)

[api_keys]
key1[api_keys] = "yourmcapikey-usx"
key1[active] = true

key2[api_keys] = "yourmcapikey-usx"
key2[active] = false

Whichever key[active] is true will be used., _(*7)

config.ini is excluded in the .gitignore file. Make sure this is not changed!, _(*8)

1. Instantiate with $mc = new MailChimp\MailChimp;
2. print_r($mc->getAccountInfo()); should return the MailChimp API Root call.

If downloading this repo directly: 1. From your command line, navigate to the MailChimp folder and run composer update to download Dependencies. 2. Add the package to your add require_once 'MailChimp/vendor/autoload.php' in your file. 3. Instantiate with $mc = new MailChimp\MailChimp; 4. print_r($mc->getAccountInfo()); should return the MailChimp API Root call., _(*9)

Using the Wrapper

Each MailChimp collections (lists, campaigns, e-commerce etc.) is accessed using a method found at the bottom of the MailChimp.php file that instantiates the collection's class., _(*10)

For example: Assuming your MailChimp instance is stored in the $mc variable, _(*11)

Lists

$mc->lists()->getLists();, _(*12)

This would return the response from calling /lists http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists, _(*13)

E-commerce

Adding a new store customer:, _(*14)

$mc->ecommerce()->customers()->addCustomer("STORE123", "CUST123", "freddie@freddiesjokes.com", true);, _(*15)

This would create a new customer to the store with id STORE123 with the customer id CUST123 and the email address freddie@freddiesjokes.com and an opt-in status of true which subscribes the customer to the list., _(*16)

Collection Reference * authorizedApps() * automations() * batchOps() * campaignFolders() * campaigns() * conversations() * ecommerce() * - ecommerce()->carts() * - ecommerce()->customers() * - ecommerce()->orders() * - ecommerce()->products() * fileManager() * lists() * reports() * templateFolders() * templates(), _(*17)

See complete list of available methods for each class/collection here, _(*18)

Docs also able to be run locally from the docs/index.html, _(*19)