squarebit/dovetail

Teamwork API的Laravel 5包装器

1.0.1 2018-02-24 15:37 UTC

This package is not auto-updated.

Last update: 2024-09-15 05:28:52 UTC


README

在Laravel 5中轻松、流畅地访问Teamwork.com数据。

看看你能有多少乐趣!

code sample

仍不确定?查看API速查表,了解如何与API交互。

快速入门指南

安装

composer require squarebit/dovetail

如果你不在Laraqve 5.5+上,你必须手动将服务提供者添加到你的app/config.php文件中

/**
 * Custom Service Providers
 */
SquareBit\Dovetail\ServiceProvider::class,

配置API设置

php artisan vendor:publish --provider="SquareBit\Dovetail\ServiceProvider"

现在你可以在config/dovetail.php中设置默认API密钥和Teamwork.com域名。

需要密钥?请参阅Teamwork.com文档:获取API密钥

用法

让我们获取最新的账户活动,怎么样?

<?php
$dovetail = new \SquareBit\Dovetail\Dovetail;
    
$allActivity = $dovetail->activity()->all();

想更改你认证的身份?这也很容易。你可以通过方法编程设置配置,或者传递一个ApiClient对象

<?php

// Set all at once!
$dovetail = new \SquareBit\Dovetail\Dovetail(
    new \SquareBit\Dovetail\Api\Client('my-api-key', 'https://myDomain.teamwork.com')
);
$allActivity = $dovetail->activity()->all();

// Or with a method...
$dovetail = new \SquareBit\Dovetail\Dovetail;
$dovetail->apiClient->setApiKey('my-new-key');
$dovetail->apiClient->setApiUrl('https://myDomain.teamwork.com');

$allActivity = $dovetail->activity()->all();

完整API速查表

想要更多?查看完整的API速查表

https://squarebit.io/zschuessler/dovetail/documentation/getting-started/api-request-cheat-sheet

想要看官方的快速入门指南?在这里

https://squarebit.io/zschuessler/dovetail/documentation/getting-started/quickstart-guide

路线图

以下端点将在2018年2月28日之前添加

  • 董事会
  • 类别
  • 日历事件
  • 文件
  • 时间跟踪

对于商业用户,完整的webhook支持将在2018年3月1日可用。你可以完全消费和响应Teamwork.com事件 - 哇!你可以在SquareBit.io Dovetail页面上获得无限使用许可。

单元测试

此包有75个以上的单元测试,并不断增加。如果你感兴趣,请参阅SquareBit.io上的商业许可证。

许可证

如果你是商业用户或打算进行商业用途,请购买许可证:Dovetail on SquareBit.io

如果你打算在不进行商业用途的情况下使用此存储库,代码根据Creative Commons Attribution NonCommercial (CC-BY-NC)许可。