jakedewitt87 / php-isdk-php7
PHP 7 版本的非官方 Infusionsoft API PHP SDK。
1.0.0
2016-10-21 19:23 UTC
Requires
- php: >=5.2.0
- ext-curl: *
This package is not auto-updated.
Last update: 2024-09-14 20:04:05 UTC
README
注意:此 PHP-iSDK 已弃用,将于 2015 年 4 月 30 日从 Infusionsoft 的公共 GitHub 上移除。请改用 infusionsoft-php。
此 SDK 允许开发者轻松使用 PHP 与 Infusionsoft API 交互。
安装说明
此 SDK 至少需要 PHP 5.2。
- 将仓库克隆到您的系统
git clone https://github.com/infusionsoft/PHP-iSDK.git
或者,您可以使用 composer 安装
- 将 "src" 文件夹(或其内容)复制到包含 SDK 的文件夹中
配置
我们可以通过两种方式连接到 API。
-
第一种方式是使用 src/conn.cfg.php 配置文件
A. 您需要您的应用程序名称和 API 密钥
您可以在登录时访问的 URL 中找到您的应用程序名称。例如:https://YOURAPPNAME.infusionsoft.com
您可以通过用户指南中的这篇文章获取 API 密钥
http://ug.infusionsoft.com/article/AA-00442/0/How-do-I-enable-the-Infusionsoft-API-and-generate-an-API-Key.html
B. 在 src/conn.cfg.php 文件中,您需要替换以下内容
connectionName - 这可以是任何您想要的内容
applicationName - 这只是我们在第一步中获得的应用程序名称
APIKEYGOESHERE - 这是在第一步中获得的 API 密钥
-
我们可以直接将应用程序名称和 API 密钥传递给 cfgCon 函数
A. 您需要您的应用程序名称和 API 密钥
您可以在登录时访问的 URL 中找到您的应用程序名称。例如:https://YOURAPPNAME.infusionsoft.com
您可以通过用户指南中的这篇文章获取 API 密钥
http://ug.infusionsoft.com/article/AA-00442/0/How-do-I-enable-the-Infusionsoft-API-and-generate-an-API-Key.html
进行第一次 API 调用
在您想要进行 API 调用的脚本中,您需要执行以下操作
- 我们需要包含 iSDK
require_once('src/isdk.php');
- 接下来,我们需要创建一个对象
$app = new iSDK();
- 接下来,我们需要创建连接
$app->cfgCon("connectionName");
或$app->cfgCon("applicationName", "APIKEYGOESHERE");
- 接下来,我们将使用 ContactService.findByEmail 方法进行第一次 API 调用。此方法通过我们发送的电子邮件地址返回联系人信息
$contacts = $app->findByEmail('test@example.com',array('Id', 'FirstName', 'LastName', 'Email'));
这将返回具有电子邮件 'test@example.com' 的联系人的 Id、First Name、LastName 和 Email
- 最后,我们将打印返回信息到浏览器窗口
print_r($contacts);
如何使用日志记录
从版本 1.8.3 开始,iSDK 具有将 API 调用记录到 CSV 的功能。默认情况下,日志记录是禁用的。
要启用日志记录,请执行以下操作
- 在您想要记录 API 调用的脚本中,在创建对象之后添加以下内容
$app->enableLogging(1); //0 是关闭 1 是开启
- (可选) 您可以设置 CSV 的位置。默认情况下,CSV 在与 isdk.php 相同的目录中创建
$app->setLog('apilog.csv'); //这是文件的完整路径
其他函数
- infuDate() - 格式化日期字符串以用于 API。具有可选参数以进行英国日期格式。
infuDate('10/26/2013') 将返回 '20131026T06:00:00'
infuDate('10/26/2013','UK') 将返回 '2013-26-10T06:00:00'