sergey-demidov/mailerlite-api-v2-php-sdk

MailerLite API v2 PHP SDK

0.3.11 2021-06-16 06:21 UTC

README

它是MailerLite API v2官方PHP SDK的分支。

刚刚在composer.json中增加了对PHP 8的支持。

您可以在这里找到更多关于MailerLite API v2的示例和信息。

入门

为了使用此库,您至少需要PHP 7.1版本。

使用MailerLite PHP SDK有两种方式

使用Composer

如果您不熟悉Composer,可以在这里了解它。

然后您需要使用CLI运行以下简单命令

composer require mailerlite/mailerlite-api-v2-php-sdk

此库建立在PSR-7PSR-18之上。如果您收到Http\Discovery\Exception\DiscoveryFailedException异常,您需要运行

composer require php-http/guzzle6-adapter
手动(适用于共享主机,首选)

这种方法仅适用于您使用共享主机且无法使用Composer的情况。您需要下载此存档(v0.2.3),提取它并将其内容放置在项目的根目录中。下一步与使用Composer相同,您需要在index.php中requirevendor/autoload.php文件,然后让我们开始吧!

使用示例

分组API

在下面的示例中,您将看到如何初始化选定的API和一些可用的操作

  • 创建分组
  • 获取分组
  • 更新分组
  • 获取属于选定分组的订阅者
$groupsApi = (new \MailerLiteApi\MailerLite('your-api-key'))->groups();

$newGroup = $groupsApi->create(['name' => 'New group']); // creates group and returns it

$allGroups = $groupsApi->get(); // returns array of groups

$groupId = 123;
$singleGroup = $groupsApi->find($groupId); // returns single item object

$subscribers = $groupsApi->getSubscribers($groupId); // get subscribers who belongs to selected group

$subscribers = $groupsApi->getSubscribers($groupId, 'unsubscribed'); // get unsubscribed subscribers who belongs to selected group

一次使用多个API

还可以在未选择要使用的API之前初始化`MailerLiteApi\MailerLite`对象,这允许您实现更多功能。

$mailerliteClient = new \MailerLiteApi\MailerLite('your-api-key');

$groupsApi = $mailerliteClient->groups();
$groups = $groupsApi->get(); // returns array of groups

$fieldsApi = $mailerliteClient->fields();
$fields = $fieldsApi->get(); // returns array of fields

使用您首选的HTTP客户端

MailerLite SDK默认使用cURL作为HTTP客户端,但也很容易使用您首选的客户端。这是通过使用符合PSR-7规范的HTTP客户端抽象HTTPlug来实现的。

以下是如何使用Guzzle而不是cURL的示例

$guzzle = new \GuzzleHttp\Client();
$guzzleClient = new \Http\Adapter\Guzzle6\Client($guzzle);

$mailerliteClient = new \MailerLiteApi\Mailerlite('your-api-key', $guzzleClient);

支持和反馈

如果您发现任何错误,请直接在这里的GitHub中提交问题。

欢迎您为任何其他编程语言创建SDK。

如果您在使用我们的API或SDK时遇到任何问题,请通过电子邮件info@mailerlite.com联系我们。

官方文档在https://developers.mailerlite.com