iconneqt/rest-api-client

为 iConneqt REST API 提供的 PHP 类库。

1.0.6 2017-12-08 09:12 UTC

This package is not auto-updated.

Last update: 2024-09-21 17:41:58 UTC


README

版本 1.0.6

为 iConneqt REST API 提供的 PHP 类库。

license Build Status

版权所有 © 2016-2017 Advanced CRMMail Technology B.V.

文档

API 文档可以在这里找到: http://demo.iconneqt.nl/api/docs/

安装

可以使用包含在 src/autoloader.php 中的自动加载器,或者使用 Composer 进行安装

composer require iconneqt/rest-api-client

src 目录中的类层次结构。

如果您使用 Composer,可以将 src 添加到自动加载器中,如下所示

/* @var $loader Composer\Autoload\ClassLoader */
$loader = require 'path-to-vendor/autoload.php';
$loader->add('Iconneqt', 'path-to-src');

最重要的两个类如下

\Iconneqt\Api\Rest\Iconneqt

对 iConneqt REST API 的高层次访问,返回丰富对象,您可以从这些对象进一步探索/深入 API。

Iconneqt 类的方法调用返回对象,属性可以通过getter访问,并且可以从 REST API 查询更多对象。

或者,您可以直接使用 Iconneqt 类。

\Iconneqt\Api\Rest\Client\Client

Iconneqt 类内部使用的低级别 API 访问组件。

基本上,这个类是对 cURL 的一种略微通用的包装,为 iConneqt REST API 做了一些轻量级的调整。

如果您想使用 REST API 提供的所有功能,或者想绕过对象的使用,则可能想使用此类。

Client 类的方法调用默认返回 stdClass 对象,但可以设置为返回关联数组。

示例

example 目录中的示例。

示例的认证

  • 将文件 auth.example.ini 复制到 auth.ini
  • 在新文件中放入您的 iConneqt 用户名和密码。
  • 如果您在 demo.iconneqt.nl 之外的服务器上,请相应地更改 auth.ini 文件中的 URL。

示例

  • check_email 展示了一个简单的表单,用于检查给定列表中是否存在电子邮件地址。从这个示例开始,作为对 Iconneqt 类的介绍。
  • form 展示了一个动态表单,用于将新订阅者添加到列表中。
  • low-level 展示了直接使用 Client 类。