README

此库提供了对Mailchimp REST API的便利包装函数。API文档在此处。

要求

• PHP 5.4.0或更高版本（如果您想使用phpunit，则需要7.0或更高版本）
• Composer
• Guzzle

安装

依赖由Composer管理。安装Composer后，从库根目录运行以下命令

composer install --no-dev --ignore-platform-reqs

或者使用phpunit安装

composer install

用法

获取您的账户信息

一个基本的测试来确认库已设置并功能正常。

使用OAuth访问令牌

<?php
require 'PATH_TO_LIBRARY/mailchimp-api-php/vendor/autoload.php';

// Instantiate MailchimpApiInterface
$authentication_settings = [
  'access_token' => 'YOUR_ACCESS_TOKEN',
  'data_center' => 'YOUR_DATA_CENTER',
  'api_user' => 'oauth',
];

// Use Mailchimp2 class for OAuth access_token.
$api_class = new Mailchimp2($authentication_settings);

// Instantiate a MailchimpApiUser or a class that extends it (ie. MailchimpLists, MailchimpSignups, etc..)
$mailchimp = new MailchimpApiUser($api_class);

// Get the account details of the authenticated user.
$response = $mailchimp->getAccount();

// Output the account details.
if (!empty($response) && isset($response->account_id)) {
  echo "ID: {$response->account_id}\n"
  . "Name: {$response->account_name}\n";
}

使用API密钥

require 'PATH_TO_LIBRARY/mailchimp-api-php/vendor/autoload.php';

// Instantiate MailchimpApiInterface
$authentication_settings = [
  'api_key' => 'YOUR_API_KEY',
  'api_user' => 'api_key',
];

// Use Mailchimp class for api_key.
$api_class = new Mailchimp($authentication_settings);

// Instantiate a MailchimpApiUser or a class that extends it (ie. MailchimpLists, MailchimpSignups, etc..)
$mailchimp = new MailchimpApiUser($api_class);

// Get the account details of the authenticated user.
$response = $mailchimp->getAccount();

// Output the account details.
if (!empty($response) && isset($response->account_id)) {
  echo "ID: {$response->account_id}\n"
  . "Name: {$response->account_name}\n";
}ject = new MailchimpApiUser($api_class, $http_options);

获取列表及其兴趣类别

一个更复杂的示例，它从一个API调用中获取响应并使用该数据执行另一个操作。

<?php
require 'PATH_TO_LIBRARY/mailchimp-api-php/vendor/autoload.php';

$authentication_settings = [
  'access_token' => 'YOUR_ACCESS_TOKEN',
  'data_center' => 'YOUR_DATA_CENTER',
  'api_user' => 'oauth',
];
$api_class = new Mailchimp2($authentication_settings);

$mailchimp_lists = new Mailchimp\MailchimpLists($api_class);

// Get all lists.
$response = $mailchimp_lists->getLists();

if (!empty($response) && isset($response->lists)) {
  foreach ($response->lists as $list) {
    // Output the list name.
    echo "List name: {$list->name}\n";

    // Get the list's interest categories.
    $interests = $mailchimp_lists->getInterestCategories($list->id);

    // Output the names of the list's interest categories.
    if (!empty($interests) && isset($interests->categories)) {
      foreach ($interests->categories as $category) {
        echo "Interest category: {$category->title}\n";
      }
    }
  }
}

测试

此库包含一个PHPUnit测试套件。

运行PHPUnit测试

将Composer的vendor目录添加到您的PATH中，请将以下行添加到您的配置文件。这取决于您的系统，但在Linux或Mac OS X系统上使用Bash时，您通常可以在~/.bash_profile中找到该文件。

export PATH="./vendor/bin:$PATH"

Bash示例

echo 'export PATH="./vendor/bin:$PATH"' >> ~/.bash_profile
source ~/.bash_profile

然后运行PHPUnit

phpunit