sun-asterisk / chatwork-php

Chatwork API PHP 客户端库

v0.2.0 2020-10-22 07:27 UTC

This package is auto-updated.

Last update: 2024-09-23 09:42:58 UTC


README

Build Status Latest Stable Version Codecov GitHub

需求

  • PHP >= 7.0
  • PHP cURL

安装

使用 composer

composer require sun-asterisk/chatwork-php

用法

您可以在这里注册 API Token。

使用 API Token 或访问 Token 创建 chatwork 客户端

use SunAsterisk\Chatwork\Chatwork;

$chatwork = Chatwork::withAPIToken('your-api-token');

// $chatwork = Chatwork::withAccessToken('your-access-token');

像以下示例一样使用 chatwork 客户端方法

// 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();

API 方法组织方式类似于官方 API 文档,例如。

消息构建器

有一个助手可以轻松创建消息。

use SunAsterisk\Chatwork\Helpers\Message;

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

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

您也可以通过 Chatwork 类的静态方法访问它。

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

验证 webhook 有效载荷

还有一个助手可以验证 webhook 有效载荷签名。

use SunAsterisk\Chatwork\Helpers\Webhook;

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