Chatwork PHP API client library

About

Đây chỉ là một SDK không chính thức cho API client library viết bằng PHP. Nó có thể không hoạt động trong tương lai nếu Chatwork cập nhật API của họ trong tương lại. Trong SDK này chúng tôi sử dụng phiên bản API mới nhất của Chatwork là version 2.

Requirement

Chatwork-php yêu cầu phiên bản PHP từ 7.0 trở lên. Ngoài ra Chatwork-php sử dụng cURL để gửi request nên bạn cũng cần phải có cURL cũng như extension cURL cho PHP.

Installation

Bạn có thể cài đặt chatwork-php thông qua câu lệnh composer:

composer require sun-asterisk/chatwork-php

Usage

  • Trước tiên, để sử dụng được các hàm API mà Chatwork cung cấp, bạn cần đăng ký một chuỗi token tại đây. Hãy chú ý rằng API token không giới hạn thời hạn có nghĩa là mỗi nguời chỉ có một API token không thay đổi theo thời gian, vì vậy để lộ chuỗi token đó cho bất kỳ ai, bởi họ có thể sử dụng token để đọc hay gửi message với account của bạn.

  • Khi đã có API token bạn có thể tạo một chatwork client như sau:

    use SunAsterisk\Chatwork\Chatwork;
    
    $chatwork = Chatwork::withAPIToken('your-api-token');
    
    // $chatwork = Chatwork::withAccessToken('your-access-token');
    

    Sử dụng các chức năng của Chatwork-php như các ví dụ sau:

    // Get your personal information.
    $me = $chatwork->me();
    
    // Get your personal tasks.
    $tasks = $chatwork->my()->tasks();
    
    // Get members in a room.
    $members = $chatwork->room($roomId)->members();
    

    Chatwork-php hiện đã cover hết tất cả những API mà Chatwork cung cấp. Danh sách đó các bạn có thể tham khảo ở trang Developer của Chatwork. Bạn có thể gửi request đến tất cả các Enpoint mà Chatwork cung cấp thông qua các hàm trong class Chatwork.

Advanced

Bên cạnh việc cover hết toàn bộ các API mà Chatwork cung cấp hiện tại thì chatwork-php còn cung cấp các Class và các hàm hữu ích để bạn có thể viết code theo một cách hướng đối tượng hơn, cũng như đơn giản hoá rất nhiều tác vụ.

Một ví dụ về một cách đơn giản khởi tạo một tin nhắn:

use SunAsterisk\Chatwork\Helpers\Message;

$message = new Message('Hi there')
    ->info('Cloudy', 'Weather today');

$chatwork->room($roomId)->messages()->create((string) $message);

Bạn cũng có có thể tạo bằng cách sử dụng phương thức static của class Chatwork:

$message = Chatwork::message('Hi there');

Ngoài ra, chatwork-php còn cung cấp chức năng mà API version 2 hỗ trợ đó là webhook. Bạn có thể hiểu thêm về webhook tại đây. Cách dùng như sau:

use SunAsterisk\Chatwork\Helpers\Webhook;

$isValid = Webhook::verifySignature($yourWebhookToken, $requestBody, $signature);

Contributing

  • Fork
  • Clone
  • Viết code & test case
  • phpunit
  • Push code
  • Pull request