kintone
zapier
kintoneDay 15

Zapierで好みのkintone REST API を叩く方法

この記事はkintone Advent Calendar 2017 の 15日目の記事です。

クラウド型業務システムのプラットフォームである「kintone」とウェブサービス同士を繋げてくれる自動化サービスZapierを活用した内容となります。
この記事では、Zapierで好みのkintone REST APIを叩く方法を紹介します。

Zapierとは

Zapierはクラウドサービス同士を簡単に繋げてくれるサービスです。
ほとんどの場合、ノンコーディングで連携を実現することが出来るパワフルなツールです。

Zapierで連携を実現するには、『トリガー』と『アクション』にウェブサービスを設定する必要があります。
例えば:
・トリガー: Evernoteに新しいノートが作成される時
・アクション: kintoneのアプリにEvernoteのノート情報が登録される

上記のようにEvernoteとkintoneをトリガーとアクションに設定すると、簡単にウェブサービスの連携が実現されます。

Zapierでサポートされているkintoneアクション

現在、Zapierにkintoneのアクションが5つあります。
つまり、何かしらのサービスをkintoneと繋げた場合、5つのアウトプットから選べるということです。
https://zapier.com/apps/kintone/integrations

zapier_actions.png

例えばですが、あるサービスで顧客管理をしていた場合、その顧客情報を更新したらkintoneの中の顧客管理を自動的に更新する、ということが出来ます。しかもコーディングする必要が全くありません。便利ですね~٩( 'ω' )و

Zapier上のkintone アクションの限界

便利なactionが5つも用意されていますが、当然ながらこれ以外のアクションを選ぶことが出来ません。スペースを作成したくても、スペースを作成するアクションがありません、

この記事では、kintoneのアクションのリストに乗っていない自分が必要なアクションを設定する方法を紹介します。

例としてですが、Twitterに特定のキーワードが入ったツイートが投稿された場合、その情報をkintoneのスペースのスレッドに投稿する連携を設定してみましょう。

Triggerの設定

サービスのリストからTwitterを選び、『Search Mention』トリガーを選択し、自分のTwitterアカウントを認証します。
今回は『サイボウズ』というキーワードがTweetされたら、そのツイートの情報をピックアップするようにします。
zap_tweet_setup.png

Triggerの設定は以上です。

Actionの設定

Actionの種類

では、Actionに移りましょう。ここではkintoneを選ばずに、『Webhooks』を選択しましょう。
zap_tweet_setup2.png

Zapierの『Webhooks』は自分の設定したAPI情報に基いて、APIを叩いてくれる便利なアクションです。選択したら、『Custom Request』を選択してください
(本当はPOSTの選択肢を選びたいところなのですが、kintoneのAPIに使用するBodyの構造が複雑なため、POSTの選択肢の設定だと対応が出来ません)
zap_tweet_setup3.png

詳細な設定を入れていきます。
基本的には、cybozu developer network に記載されているAPIの情報を入れていけば大丈夫です。今回はスペースのスレッド内コメントの投稿APIの情報を参照しながら設定値を入れていきましょう。

Actionの設定値

Method

zap_tweet_method.PNG
HTTPメソッドです。
スペースのスレッド内コメントの投稿API のHTTPメソッドはPOSTなので、POSTを選択します。

URL

zap_tweet_url.PNG
APIのURLです。
自分が使用しているサブドメインが入った、下記のURLを入れれください。
https://サブドメイン名.cybozu.com/k/v1/space/thread/comment.json

上記の例はcybozu.comを使用していますが、kintone.com (USドメイン)でももちろん活用出来ます。

Data Pass-through?

zap_tweet_passthrough.PNG
yesにすると後に入力する設定が無視されてしまうらしいので、こちらはnoに設定します。

Data

スペースのスレッド内コメントの投稿API のリクエスト例を参考にし、Bodyを作成します。
必須のパラメータは space, thread, comment のみなので、とりあえず最小限のBodyの構造を入れてみましょう。


{
    "space": 10,
    "thread": 16,
    "comment": {
        "text": "test"
    }
}

space と thread の値は、投稿先のスペースとスレッドのIDを入れる必要があります。
スペースとスレッドのIDは、ブラウザでスレッドに移動すればURLの中で確認することができます。
zap_tweet_spacethreadids.PNG

上記のBodyの例では、コメントされる内容を"test"にしちゃいましたが、変わりにTwitterが取得した値を入れることが出来ます。下記のように、Twitterが取得した値を入れてみましょう。
zapier_tweet_setup.gif

Unflatten

zap_tweet_unflatten.PNG
この設定は勝手にアンダースコアを別のものに変換するっぽく、害があるっぽいのでnoにします。

Basic Auth

zap_tweet_basicauth.PNG
Basic認証の認証情報です。
自分の環境にBasic認証を設定している場合は情報を入れて下さい(Basic認証の設定方法)。

Headers

zap_tweet_headers.PNG
APIに載せるヘッダーの情報です。
Content-Type と application/json のペアは必要です。
パスワード認証に必要な X-Cybozu-Authorization の値には、kintoneのユーザアカウントの【ログイン名:パスワード】をBase64でエンコードしたものを入力してください。この認証方法の詳細についてはcybozu developer networkを参照してください。

ちなみにですが、ここの設定ではX-Cybozu-API-Tokenは使えません。APIトークン認証はアプリにしか活用できず、スペースには活用出来ません(早くスペース用APIトークンを実装してくれー!)。

APIのテスト

APIの設定が一通り終わると、Zapierが一回試しにAPIを叩いてくれます。成功した場合、Test was successfulと表示してくれます。Finishを押して、完了をします。
zap_tweet_successful.PNG

APIの情報に誤りがあると、このステップでエラーの内容が表示されます。パスワード認証、URL、メソッド、jsonの構造が正しいかを確認し、またトライしてみましょう。

最後の設定

最後に、この連携(Zap)をつねにONにするかどうかを聞かれます。
zap_tweet_save.PNG

フリーのプランだと、一ヶ月に100タスクまでしか処理してくれません。この記事の例だと、kintoneのスレッドに情報を投稿するまでの流れが1タスクとしてカウントされます。

Zapierには色々とプランがありますので、詳細な情報はウェブサイトで確認しましょう。
https://zapier.com/app/billing/plans

実行結果

ZapをONにすると、『サイボウズ』が含まれたツイートがされた際にツイートの内容とURLがkintoneのスペースのスレッドに投稿されます。
tweets_in_space.png

上手くスレッドに情報が投稿されましたでしょうか?
今回はjsonボディの中身をシンプルにしましたが、スレッドへの投稿内容を綺麗にしたり、他のkintoneユーザにメンションしたりもできます。

最後に

この記事ではスペースのスレッド内コメントの投稿APIを活用しましたが、もちろん他のkintone APIも同じようにZapierのWebhooksアクションに設定することが出来ます。

是非、試してみましょう!