Webhookを利用する

Rakuten RapidAPIのWebhookを利用してみましょう。


Webhookについて

Webhookを利用すると、アプリをAPIに接続し、APIのさまざまなイベントを通知することができます。例えば、GitHubで新規コミットが作成されたり、SlackやFacebook Messengerでメッセージで受け取ったりする度に、アプリで通知を受け取ることができます。

Rakuten RapidAPI Webhooksを使えば、複数のWebhookに簡単に接続することができます。また、Webhookの到達先として一般にアクセス可能なエンドポイントを作成する必要がなくなります。つまり、以下のことが言えます。

  • ローカルホスト上での不具合修正が簡単に - 不具合を修正するのに公開IPは必要ありません。
  • 安全性の向上 - Rakuten RapidAPIにSSLソケットで直接接続されているため、ほかの人があなたにメールを送ることはできません。
  • 速度の向上 - 自分のサーバーとRakuten RapidAPIのサーバーとの間に開かれたソケットが保持され、プロトコルのオーバーヘッドが大幅に排除されます。

現在Webhookをサポートしているパッケージ

Slack SendGrid Intercom
Facebook Messenger Shopify Twilio
PubNub Mandrill PayPal
GitHub Dropbox Telegram
Box Dropbox Business Stripe
Trello BrickFTP OnFleet
Segment

Webhookの利用

Rakuten RapidAPIでは、Webhookが利用できるパッケージにはWebhooksのタグが表示されるようになっています。

alt text

図1. Webhookが利用可能なパッケージ

使用したいAPIを選択すると、概要画面にリダイレクトされ、APIがサポートするすべてのWebhook関数を見ることができます。利用したいWebhook関数をクリックするとドキュメント画面へと移動し、そのWebhook関数への接続に必要なすべての手順を確認できます。

コードスニペット

関数ページの一番右側のパネルにはコードスニペットが表示され、自分のアプリにコピーすることができます。イベントが発生するたびに、そのコードスニペット内の関数が呼び出されます。(使っている言語のSDKのダウンロードをお忘れなく!)

テストイベント

テストイベント」ボタンを使用することで、自分のコード内でWebhook接続をテストすることもできます。そのボタンを使うとフェイクのイベントが発生し、実際にアプリが適切に接続されるかどうかを確かめることができます。コードスニペットを自分のアプリケーションにコピーし、アプリケーションを実行して、「テストイベント」ボタンをクリックするだけテストできます。セットアップの必要はありません。

Webhookのセットアップ

通知したいイベントを見つけて、動作のテストが完了したら、Webhookセットアップ方法について記載された手順に従ってください (注:提供されたURLをコールバックとして使用することが重要です)。これですべての準備は完了です。また、そのイベントに必要なパラメータの入力も必要になります。それぞれのWebhookに必要なセットアップについての詳細な説明については、ドキュメントをご確認ください。