README

这是一个简单的PHP库，可以轻松实现与activeCollab 4 API的通信。如果您正在寻找一个与Active Collab 5及更高版本兼容的库，请使用此包。

首次连接

下拉以下示例的最新标签（1.0.x）。请勿使用develop分支与activeCollab 4.2.x一起使用！

为了连接，您需要API URL和API令牌。

要获取这些详细信息，请转到您的activeCollab用户配置文件，从“选项”下拉菜单中选择“API订阅”。点击“新建订阅”按钮并填写表单（客户端名称是您的应用程序将通过API与activeCollab通信的名称）。在为您的应用程序创建API订阅后，点击放大镜图标以打开一个对话框，该对话框将显示该订阅的API URL和令牌。

现在您已经拥有了API令牌和URL，您可以测试这个简单的示例

<?php

  require_once 'ActiveCollab/autoload.php';

  use \ActiveCollab\Client as API;
  use \ActiveCollab\Connectors\Curl as CurlConnector;
  use \ActiveCollab\Exceptions\AppException;

  API::setUrl('MY-API-URL');
  API::setKey('MY-API-TOKEN');
  API::setConnector(new CurlConnector);

  print '<pre>';
  print_r(API::info());
  print '</pre>';

此示例将联系activeCollab并请求应用程序和用户信息。响应是一个简单的关联数组，其中包含与您正在通信的系统的大量详细信息。

使用Composer

如果您选择使用composer安装此应用程序而不是拉取git仓库，您需要将composer.json文件添加到您想要拉取仓库的位置。

{
    "require": {
        "activecollab/activecollab-sdk": "1.0.*"
    }
}

运行composer update安装包。要测试API，请将以下内容添加到PHP文件中并运行它。

<?php

  require_once 'vendor/autoload.php';

  use \ActiveCollab\Client as API;
  use \ActiveCollab\Connectors\Curl as CurlConnector;
  use \ActiveCollab\Exceptions\AppException;

  API::setUrl('MY-API-URL');
  API::setKey('MY-API-TOKEN');
  API::setConnector(new CurlConnector);

  print '<pre>';
  print_r(API::info());
  print '</pre>';

执行API调用

列出项目#65中的所有任务很容易。只需调用

API::call('projects/65/tasks');

此示例展示了您如何在所选项目中创建新的任务

try {
  API::call('projects/65/tasks/add', null, array(
    'task[name]' => 'This is a task name',
    'task[assignee_id]' => 48,
    'task[other_assignees]' => array(3, 1),
  ), array(
    '/attach.jpeg'
  ));
} catch(AppException $e) {
  print $e->getMessage() . '<br><br>';
  // var_dump($e->getServerResponse()); (need more info?)
} // try

call()方法可以接受四个参数

1. command（必需）- API命令，
2. 额外命令参数（可选）- 将附加到命令的额外变量。大多数命令不需要任何额外的命令参数，但有些命令需要（例如，dont_limit_result参数用于跟踪时间和费用列表命令），
3. POST变量 - POST变量的数组。请注意，您不需要添加submitted变量（它会自动为您添加），
4. 附件 - 应附加到正在创建或更新的对象的文件路径列表。

有关可用的完整API命令列表，请参阅activeCollab API文档。