https://github.com/timkley/awork-php-sdk

PHP HTTP Client for the awork API
https://github.com/timkley/awork-php-sdk

Last synced: 5 months ago
JSON representation

PHP HTTP Client for the awork API

• Host: GitHub
• URL: https://github.com/timkley/awork-php-sdk
• Owner: timkley
• License: mit
• Created: 2021-07-23T11:57:30.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-04T06:06:52.000Z (about 1 year ago)
• Last Synced: 2024-04-04T15:01:38.851Z (about 1 year ago)
• Language: PHP
• Size: 222 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# awork.com PHP SDK

[![Latest Version on Packagist](https://img.shields.io/packagist/v/timkley/awork-php-sdk.svg?style=flat-square)](https://packagist.org/packages/timkley/awork-php-sdk)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/timkley/awork-php-sdk/run-tests.yml?label=tests)](https://github.com/timkley/awork-php-sdk/actions?query=workflow%3Arun-tests+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/timkley/awork-php-sdk.svg?style=flat-square)](https://packagist.org/packages/timkley/awork-php-sdk)

This is a wrapper around the [awork API](https://openapi.awork.com/).

## Installation

### Requirements

> PHP 8.2 and above

### With composer

```bash

composer require timkley/awork-php-sdk

```

## Usage

You need an [API token](https://developers.awork.com/authentication) to use the awork API.

```php

users()->get();

// Get a specific project

$awork->projects()->getProject('your-product-uuid');

// Post a comment on a specific task

$awork->comments()->create('tasks', 'your-task-uuid', 'Your message');

```

## Testing

```bash

./vendor/bin/pest

```

## Credits

I took a lot of inspiration from existing packages like [mailgun/mailgun-php](https://github.com/mailgun/mailgun-php)

or [lepikhinb/fathom-api](https://github.com/lepikhinb/fathom-api).

Thanks for contributing to open source!

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.