testmonitor/clickup-client

TestMonitor Clickup 客户端。

v1.1.0 2024-05-14 09:31 UTC

This package is auto-updated.

Last update: 2024-09-15 12:38:00 UTC


README

Latest Stable Version CircleCI StyleCI codecov License

本包提供了一个非常基本、方便且统一的 Clickup 包装器。

目录

安装

要安装客户端,您需要使用 composer 引入该包

$ composer require testmonitor/clickup-client

使用 composer 的自动加载

require __DIR__.'/../vendor/autoload.php';

现在您已设置完毕!

用法

此客户端仅支持 OAuth 认证。您需要 Clickup 应用程序才能继续。如果您还没有这样做,请参阅 Clickup 认证文档 了解如何创建应用程序。

当您的 Clickup 应用程序启动并运行时,开始进行 OAuth 授权

$oauth = [
    'clientId' => '12345',
    'clientSecret' => 'abcdef',
    'redirectUrl' => 'https://redirect.myapp.com/',
];

$clickup = new \TestMonitor\Clickup\Client($oauth);

header('Location: ' . $clickup->authorizationUrl());
exit();

这将重定向用户到一个页面,要求确认您的应用程序获取 Clickup 的访问权限。请确保您的 redirectUrl 指向您的应用程序。此 URL 应指向以下代码

$oauth = [
    'clientId' => '12345',
    'clientSecret' => 'abcdef',
    'redirectUrl' => 'https://redirect.myapp.com/',
];

$clickup = new \TestMonitor\Clickup\Client($oauth);

$token = $clickup->fetchToken($_REQUEST['code']);

如果一切顺利,您应该有一个访问令牌(通过 Token 对象可用)。它将有效 一小时。之后,您将需要刷新令牌以恢复访问权限

$oauth = ['clientId' => '12345', 'clientSecret' => 'abcdef', 'redirectUrl' => 'https://redirect.myapp.com/'];
$token = new \TestMonitor\Clickup\AccessToken('eyJ0...'); // the token you got last time

$clickup = new \TestMonitor\Clickup\Client($oauth, $token);

示例

获取 Clickup 工作空间的列表

$workspaces = $clickup->workspaces();

或创建一个任务,例如(使用列表 ID 12345)

$workItem = $clickup->createTask(new \TestMonitor\Clickup\Resources\Task([
    'name' => 'Name of the task',
    'description' => 'Some description',
]), '12345');

测试

该包包含集成测试。您可以使用 PHPUnit 运行它们。

$ vendor/bin/phpunit

变更日志

有关更多信息,请参阅 变更日志

贡献

有关贡献详细信息,请参阅 贡献指南

致谢

许可证

MIT 许可证(MIT)。有关更多信息,请参阅 许可证