今日は、FuelPHPのChatWorkパッケージを紹介します。
ChatWorkのAPIは、昨月(2013年11月)末にプレビュー版として公開されました。
http://blog-ja.chatwork.com/2013/11/api-preview.html
そこで早速、FuelPHPのパッケージとして実装してみました。
https://github.com/mp-php/fuel-packages-chatwork
ChatWorkパッケージのライセンスはMITライセンスです。
http://opensource.org/licenses/MIT
では、準備と使い方の説明です。
1. ChatWorkのAPIトークンを発行する
現在、ChatWorkのAPIはプレビュー版なので、利用の申請が必要です。
の"お申し込み方法"の通りに、APIの利用申請をします。後日、利用開始のメールが届きます。
利用開始のメールが届いたら、APIトークンを発行します。
の、"APIトークンの取得"の通りです。発行されたAPIトークンは後で使いますので、控えておいて下さい。
2. FuelPHPとChatWorkパッケージのインストール
FuelPHPのインストールを済ませて、トップページが閲覧可能な状態にします。以下の手順はFuelPHP1.7.1で確認していますが、composer対応以降のバージョンであれば問題無いと思います。
次に、composer.json の"require"に以下を追記します。
"mp-php/fuel-packages-chatwork": "dev-master"
次に、composer update します。
FuelPHPとChatWorkパッケージのインストールは以上です。尚、ChatWorkのAPIを使用する関係で、curlとOpenSSLを有効にしておいて下さい。
$ php composer.phar update
FuelPHPとChatWorkパッケージのインストールは以上です。尚、ChatWorkのAPIを使用する関係で、curlとOpenSSLを有効にしておいて下さい。
3. ChatWorkパッケージの設定
fuel/packages/chatwork/config/chatwork.php を fuel/app/config/ にコピーして、ChatWorkのAPIトークンを設定します。
<?php return array( 'api_token' => 'ここにChatWorkのAPIトークンを設定します。', );
次に、ChatWorkパッケージを有効にします。方法は二つあります。
各所でChatWorkパッケージを使う場合は
fuel/app/config/config.php の"always_load.packages"に"chatwork"を追記します。
'always_load' => array( ... 'packages' => array( ... 'chatwork', ...
局所的にChatWorkパッケージを使う場合は
その場所(や、そのクラスのコンストラクタ等)でロードします。
Package::load('chatwork');
これで、全ての準備が完了です。
4. ChatWorkパッケージを使ってみる
自分の情報を取得してみます。http://developer.chatwork.com/ja/endpoint_me.html#GET-me
$response = Chatwork::get('/me');
Debug::dump($response);
http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-messages
$response = Chatwork::post('/rooms/[ルームID]/messages', array('body' => '内容'));
Debug::dump($response);
ルームIDは、URLに含まれる"rid"に続く数値です。"rid0123456789"であれば、ルームIDは"0123456789"になります。どちらも簡単ですね。
今回はChatwork::get()メソッドとChatwork::post()メソッドを紹介しましたが、Chatwork::put()メソッドとChatwork::delete()メソッドも用意してあります。
5. その他のAPIを使ってみる
現在、APIは大きく分けると- /me
- /rooms
- /my
- /contacts
http://developer.chatwork.com/ja/endpoints.html
どれを使うにしても
- HTTPメソッドは何か
- 必須パラメータは何か、任意パラメータにどんなパラメータがあるか
を確認すれば簡単に使えるので、ぜひ試してみてください。
最後に、現在のChatWork APIの認証はトークン式のみなので、自分(トークンの持主)が使う前提になっています。パッと思いつく使い方としては、GitHubのHookから特定のルームにメッセージを投稿する。というような、通知の自動投稿でしょうか。タスクを管理する何か。も面白そうですね。
尚、今後、OAuth 2.0式の認証も提供予定とのことです。
以上、ChatWorkパッケージの紹介でした。
No comments:
Post a Comment