valsplat/harvest-php-client

此包已被废弃,不再维护。未建议替代包。

Harvest V2 API 的 PHP 客户端

v1.0 2019-01-04 16:22 UTC

This package is auto-updated.

Last update: 2021-09-11 07:46:01 UTC


README

68747470733a2f2f7777772e676574686172766573742e636f6d2f6173736574732f70726573732f686172766573742d6c6f676f2d69636f6e2d373761366638353531303265326638356137666265303730353735663239333334366136343363333731613439636566663334316432383134653237303436382e706e67

(非官方) Harvest v2 API Client for PHP

贡献

$ git clone git@github.com:valsplat/harvest-php-client.git
$ cd harvest-php-client
$ composer update -o

安装

$ composer require valsplat/harvest-php-client

端点

此 API 客户端仍在开发中,目前尚未完成。您只能使用 ClientProjectTaskTaskAssignmentUserUserAssignment 端点。请随意创建一个 Pull Request 以增加覆盖率。

认证

认证是通过提供您的账户 ID 和个人访问令牌来完成的

$connection = new \Valsplat\Harvest\Connection();
$connection->setAccessToken('ACCESS_TOKEN');
$connection->setAccountId('ACCOUNT_ID');

在此处获取您的令牌和账户 ID: https://id.getharvest.com/oauth2/access_tokens/new

错误

API 客户端抛出两个异常

  • \Valsplat\Harvest\Exceptions\NotFoundException - 实体未找到
  • \Valsplat\Harvest\Exceptions\ApiException - 通用 API 异常

基本用法

每个端点都可通过 \Valsplat\Harvest\Harvest 实例上的单独方法访问。方法名称为单数,驼峰式

$vlak = new \Valsplat\Harvest\Harvest($connection);
$vlak->TaskAssignment();

通用方法和过滤器

  • list((array)params) - 获取实体集合。您可以在 Harvest 文档 中找到每个端点可用的参数。
  • get((int)id) - 通过其 ID 获取单个实体。
  • create() - 创建给定的实体。
  • update() - 更新给定的实体。
  • save() - 便利方法;如果实体已存在,则调用 update(),否则调用 create()
  • delete() - 删除给定的实体。

用法示例

认证和用法示例: example.php

待办事项

  • 使用模拟 HTTP 客户端的测试
  • 完整端点支持
  • 自动序列化属性