Chatwork APIの使い方

こんにちは。
Three Hands Worksの小林です。
本日はお客様からの要望が多いkintoneとChatworkの連携についてまとめようと思います。
弊社のBUILD3はサイボウズ社のkintoneをベースとしている事は、これまでにも述べたとおりです。
kintoneは社内システムを構築するにはとても便利なサービスです。
ただし、既に社内で利用しているサービスがあったりすると、サービスからの移行や社員への周知、利用方法の学習コストなどが発生します。
こういったコストをなるべくなくすために、今あるサービスはそのまま使いたいという要望がとても多いです。
その中でも「社内コミュニケーションとタスク管理はこれまで通りChatworkで」という要望は多く、弊社でもお客様同様Chatworkでのコミュニケーションとタスク管理を行っていましたので、その利便性は理解出来ます。

 

今日のポイント

ポイントとしては次の4点です。
ここを抑えてまずはChatwork APIの利用方法を学習しましょう。

  1. Chatwork APIの利用準備
  2. APIトークンの取得
  3. エンドポイントの確認
  4. curlコマンドでAPIの実行

では実際にひとつずつ見ていくことにします。

 

1. Chatwork APIの利用準備

まずは以下のリンクにアクセスしてChatwork APIの利用申請を行ないましょう。

http://developer.chatwork.com/ja/

開いたら下のキャプチャで示しているリンクをクリックしてください。

ChatworkAPIドキュメント画面

 

チャットワークAPI(プレビュー版)お申込み画面が表示されるので、画面の説明に従って「チャットワークAPIお申込み」ボタンをクリックしてください。

Chatwork APIお申込み画面

 

以下の画面が表示されればお申込みは完了です。
後日送られてくるご利用開始のお知らせメールを心待ちにしましょう。
(状況にもよるかと思いますが、弊社で申請した際は2〜3日で利用開始メールが届きました)

Chatwork APIお申込み完了画面

 

2. APIトークンの取得

ChatworkからAPI利用開始のメールが届くと、アカウントの動作設定からAPIトークンの発行が可能になります。
では、アカウントの動作設定を開いてみましょう。

動作設定

 

動作設定を開いたら、API発行タブをクリックしてください。

動作設定詳細

 

Chatworkのパスワードを入力し、表示をクリック。

APIトークン発行画面

 

APIトークンの発行がされます。
発行されたAPIトークンはコピーボタンを押してクリップボードにコピーしておきましょう。

APIトークン発行

 

3. エンドポイントの確認

APIトークンの発行が無事終わったら次は実際にChatwork APIを使って操作をしてみたいと思います。
ですが、まずはChatwork APIを使ってどんな操作が可能なのか確認をします。
ここで再びChatwork APIドキュメントの画面を開き、エンドポイントタブをクリックします。
すると、以下のようなエンドポイントについての説明画面が開きます。

エンドポイントについて

 

具体的な説明はこのドキュメントを参照してもらうとして、実際のエンドポイントの説明を見てみましょう。
今回は手始めに自分のチャット一覧の取得をしてみようと思います。
エンドポイントタブの下にある・/roomsをクリックしてください。
ここはチャットルームに対する操作方法が一覧になっています。
一覧の一番上にある以下のリンクをクリックしてください。

RoomsエンドポイントGET

 

詳細な説明が開きます。
ここではcurlコマンドを使った呼び出し方、リクエストパラメータ、レスポンスが確認出来ます。

自分のチャット一覧取得説明

 

4. curlコマンドでAPIの実行

ようやくChatwork APIを実行してみようと思います。
先ほど確認したエンドポイントからcurlコマンドの呼び出し方法をコピーします。
以下の部分ですね。

curl -X GET -H “X-ChatWorkToken: 自分のAPIトークン” “https://api.chatwork.com/v1/rooms”

自分のAPIトークンと書かれているところに、発行したAPIトークンをペーストします。
続いて、ターミナルアプリなどを開いてコマンドラインから上記のコマンドを実行してみます。

 

curlコマンド実行

Windowsユーザーの方は以下の記事からcurlコマンド実行環境を用意して試してください。

WINDOWSでCURLを使おう。あるいはMICROSOFT SECURITY ESSENTIALの定義ファイルをCURLでダウンロード。

 

実行結果が以下のように返ってきたらAPIの実行は完了です。

curlコマンド結果

もしうまく行かなかった場合は、APIトークンに間違いがないか、curlコマンドに間違いがないか再度確認してください。

 

次回はkintoneからChatwork APIを実行してみようと思います。