infusionsoft / old-php-isdk
非官方的Infusionsoft API PHP SDK
dev-master
2015-05-02 05:12 UTC
Requires
- php: >=5.2.0
- ext-curl: *
This package is not auto-updated.
Last update: 2024-09-18 09:58:27 UTC
README
注意:此PHP-iSDK已过时,并将从Infusionsoft的公共github上于2015年4月30日移除。请使用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使用。有一个可选参数用于UK日期格式。
infuDate('10/26/2013') 将返回 '20131026T06:00:00'
infuDate('10/26/2013','UK') 将返回 '2013-26-10T06:00:00'