...
...
...
...
...
このセクションでは、CloudGearアプリケーションがCloudGearのWebHookを受け取る為の実装について説明いたします。
WebHookについて
WebHookは、CloudGear
...
に契約またはサービススクエアが作成/削除されたときや、ユーザーがスクエアに加入/脱退したときなどに、CloudGearアプリケーション
...
のバックエンドサーバーにその情報を伝えるための仕組みです。
サービスに設定されているWebHookバージョンによって、送信されるイベントが異なります。
現在、Version1は最低限のメンテナンスのみに留まっており、新規機能の追加などは行われておりません。特別な理由がない限りはVersion2をご利用ください。
WebHookの種類
WebHookは、いくつかのタイプを持ちます。
Version1
タイプ | 説明 |
|---|---|
| |
|
...
Version2
イベント |
|---|
...
タイプ |
|---|
...
説明 |
|---|
...
|
...
|
...
ユーザーの追加・削除などユーザーに関連した変更が発生した場合に発行されるWebHookです。 |
...
|
...
スクエアにユーザーを招待
| Note |
|---|
招待されたユーザーがスクエアへの参加を承認した段階で発行されます。 |
...
WebHookの実装
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|
WebHookリクエスト
以下のフォーマットの内容でCloudGearからCloudGearアプリケーションにHTTPリクエストが送信されます。
HTTPリクエストの送信先は、サービスマネージャのWebHookで設定したエンドポイントとなります。
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"event": "squareprovisioning",
"data": [{
"serviceId": 1, //サービスID
"plans": [{
"id": "planId", // プランID
"action": "ADD|DELETE|UPDATE" // プラン操作
}],
"squareId": "squareId", // スクエアID
"action": "ADD|DELETE", // スクエアへの操作
"cause": "cause" // 操作理由、なければ空
}]
} |
...
| language | js |
|---|---|
| title | idprovisioning |
...
| サブスクリプションを管理する契約管理者の任命・解任が発生した場合に発行されるWebHookです。 | |
|
| ユーザー情報の変更が発生した場合に発行されるWebHookです。 |
|
| サブスクリプションの課金サイクルが更新された場合に発行されるWebHookです。 |
|
| 使用量タイプの料金プランで契約しているユーザーがいる場合に、使用量を送信するように要求するWebHookです。 |
|
| サブスクリプションの作成,更新,削除時に発行されるWebHookです。 |
WebHookの発行タイミング
WebHookは、以下のタイミングで発行されます。
タイミング | 発行されるWebHookのイベントタイプ | ||
|---|---|---|---|
サービスの申し込み |
| ||
サービス利用者による契約プランの更新 |
| ||
サービスの解約 |
| ||
スクエアにユーザーを招待
| Version1
Version2
| ||
スクエアからユーザーを削除 | Version1
Version2
| ||
契約管理者の任命 | Version2のみ | ||
契約管理者の解任 | Version2のみ | ||
ユーザー情報の更新 | Version2のみ | ||
サブスクリプションの課金サイクルの終了 | Version2のみ | ||
使用量タイプの料金プランを持つサブスクリプションに対して使用量を要求 | Version2のみ |
WebHookハンドラーの実装
サービスアプリケーションのWebHookハンドラーがとるべき振る舞いはWebHookのイベントタイプによって異なります。
各タイミングで発行されるWebHookの取り扱いや設定方法は以下のページで説明します。
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|