minstersoft/activecampaign

ActiveCampaign APIv3 PHP 7.0 连接器

2.0.0 2021-08-06 11:07 UTC

This package is auto-updated.

Last update: 2024-09-06 17:31:39 UTC


README

License

此包提供了ActiveCampaign API(v3)的PHP SDK。

testmonitor/activecampaign 分支

有关ActiveCampaign API的更多信息,请参阅他们的开发者文档

目录

安装

此包可以通过Composer安装

$ composer require minstersoft/activecampaign

本地开发和安装

1. 在composer.json中添加版本。

{
"..": "...",
"version": "1.0.0",
"...": "..."
}

2. 将url替换为您的本地路径并运行命令。

$ composer config repositories.minstersoft/activecampaign '{"type": "path", "url": "/home/vagrant/activecampaign"}'
$ composer require minstersoft/activecampaign

确保使用Composer的autoload

require __DIR__.'/../vendor/autoload.php';

在类名前添加 'use' 关键字

use Minstersoft\ActiveCampaign\ActiveCampaign;

class ClassName { 
 //...
}

首先创建一个新实例

$activeCampaign = new ActiveCampaign(ACTIVE_CAMPAIGN_URL, ACTIVE_CAMPAIGN_KEY);

您的API密钥可以在设置页面的“开发者”标签下找到。

使用

一旦实例化,您就可以简单地调用SDK提供的方法之一

$activeCampaign->contacts();

这将为您提供可用联系人的列表。

要创建联系人,可以使用createContact方法

$contact = $activeCampaign->createContact(
    'email' => 'johndoe@example.com',
    'firstName' => 'John',
    'lastName' => 'Doe',
);

当请求成功时,$contact将包含一个包含联系人详细信息的Contact对象。

要检索现有联系人或在其不存在时创建它

$contact = $activeCampaign->findOrCreateContact(
    'email' => 'johndoe@example.com',
    'firstName' => 'John',
    'lastName' => 'Doe',
);

当请求成功时,$contact将包含一个包含联系人详细信息的Contact对象。

测试

该包包含集成测试。您可以使用PHPUnit运行它们。

$ vendor/bin/phpunit

变更日志

有关更多信息,请参阅CHANGELOG

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证