Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/testmonitor/clickup-client
The TestMonitor Clickup Client.
https://github.com/testmonitor/clickup-client
api clickup client
Last synced: 2 months ago
JSON representation
The TestMonitor Clickup Client.
- Host: GitHub
- URL: https://github.com/testmonitor/clickup-client
- Owner: testmonitor
- License: mit
- Created: 2023-10-15T12:22:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T07:51:13.000Z (4 months ago)
- Last Synced: 2024-10-20T09:18:51.913Z (3 months ago)
- Topics: api, clickup, client
- Language: PHP
- Homepage: https://www.testmonitor.com/
- Size: 49.8 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TestMonitor Clickup Client
[](https://packagist.org/packages/testmonitor/clickup-client)
[](https://circleci.com/gh/testmonitor/clickup-client)
[](https://styleci.io/repos/705226623)
[](https://codecov.io/gh/testmonitor/clickup-client)
[](https://packagist.org/packages/testmonitor/clickup-client)
This package provides a very basic, convenient, and unified wrapper for [Clickup](https://clickup.com/).
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Tests](#tests)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
To install the client you need to require the package using composer:
$ composer require testmonitor/clickup-client
Use composer's autoload:
```php
require __DIR__.'/../vendor/autoload.php';
```
You're all set up now!
## Usage
This client only supports **oAuth authentication**. You'll need an Clickup application to proceed. If you haven't done so,
please read up with the [Clickup authentication docs](https://clickup.com/api/developer-portal/authentication#oauth-flow) on how
to create an application.
When your Clickup application is up and running, start with the oAuth authorization:
```php
$oauth = [
'clientId' => '12345',
'clientSecret' => 'abcdef',
'redirectUrl' => 'https://redirect.myapp.com/',
];
$clickup = new \TestMonitor\Clickup\Client($oauth);
header('Location: ' . $clickup->authorizationUrl());
exit();
```
This will redirect the user to a page asking confirmation for your app getting access to Clickup. Make sure your redirectUrl points
back to your app. This URL should point to the following code:
```php
$oauth = [
'clientId' => '12345',
'clientSecret' => 'abcdef',
'redirectUrl' => 'https://redirect.myapp.com/',
];
$clickup = new \TestMonitor\Clickup\Client($oauth);
$token = $clickup->fetchToken($_REQUEST['code']);
```
When everything went ok, you should have an access token (available through Token object). It will be valid for **one hour**.
After that, you'll have to refresh the token to regain access:
```php
$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);
```
## Examples
Get a list of Clickup workspaces:
```php
$workspaces = $clickup->workspaces();
```
Or creating a task, for example (using list id 12345):
```php
$workItem = $clickup->createTask(new \TestMonitor\Clickup\Resources\Task([
'name' => 'Name of the task',
'description' => 'Some description',
]), '12345');
```
## Tests
The package contains integration tests. You can run them using PHPUnit.
$ vendor/bin/phpunit
## Changelog
Refer to [CHANGELOG](CHANGELOG.md) for more information.
## Contributing
Refer to [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
## Credits
* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)
* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)
* **Frank Keulen** - *Developer* - [FrankIsGek](https://github.com/frankisgek)
## License
The MIT License (MIT). Refer to the [License](LICENSE.md) for more information.