通知プロファイルの管理
通知プロファイルは、イベント通知の送信先と配信方法を定義します。正しく機能するには、すべての Webhook サブスクリプションに有効な通知プロファイルが含まれている必要があります。通知プロファイルの作成、更新、削除は、 NTT CPaaS Web インターフェイス または サブスクリプション API を使用して行うことができます。
前提条件 [#prerequisites]
通知プロファイルを管理するには、次のものが必要です。
- NTT CPaaS アカウント: アクティブなアカウント。
- Webhook エンドポイント: イベント通知を受信する準備ができている、パブリックにアクセス可能な URL。
- **認証設定(オプション):**確実に配送したい場合。認証設定の管理を参照してください。
- 証明書 (オプション): 相互 TLS が必要な場合。「証明書の管理」を参照してください。
プロファイルとサブスクリプションの関係については、Webhookサブスクリプションについてを参照してください。
通知プロファイルの作成 [#create]
新しいサブスクリプションを設定するときに通知プロファイルを作成するか、複数のサブスクリプションで再利用するためにスタンドアロン プロファイルを作成します。
-
NTT CPaaS Web インターフェイスにログインし、開発者ツール > サブスクリプション管理 に移動します。
-
[通知プロファイル] タブを開きます。
-
**[通知プロファイルの作成] を選択します。
-
プロファイル情報を入力します。
- 通知プロファイル名: 文字、数字、ダッシュ、またはアンダースコアのみを使用してください。
- Webhook URL: イベント通知を受信する宛先 URL。
-
(オプション)応答の検証を追加します。
- 応答本文の正規表現: 配信が成功したと見なされるために、応答本文に表示する必要があるテキストパターン。
- 応答正規表現: 予想される HTTP ステータス コードに一致するパターン (たとえば、2xx 応答を受け入れるには
2[0-9]{2})。
-
(オプション)セキュリティ設定で、認証設定を選択するか、新しい認証設定を作成します。各方法の詳細は、認証設定の管理を参照してください。
メモ少なくとも基本認証を使用して、Webhook エンドポイントを保護します。セキュリティを強化するには、認証と相互 TLS 証明書を組み合わせます。
-
(オプション)相互TLS(mTLS)セキュリティ用の証明書を適用します。設定方法は、証明書の管理を参照してください。
-
(オプション)詳細設定を構成します。
設定 範囲 説明 最大バケットサイズ 1 から 2000 要求あたりの最大メッセージ数 ウィンドウサイズ 20 から 10000 同時接続 接続タイムアウト 300〜30000ミリ秒 接続タイムアウト 読み取りタイムアウト 1000〜90000ミリ秒 読み取りタイムアウト SSL プロトコル TLS v1.2、v1.3 有効なSSLプロトコル ヘッダー キーと値のペア リクエストで送信されるカスタムヘッダー レート制限 1 から 5000 リクエスト数/秒 -
[保存] を選択して、通知プロファイルを作成します。
通知プロファイルの作成 API エンドポイントを使用します。
新しいセキュリティ設定をインラインで作成することも、authId で既存のセキュリティ設定を参照することもできます。
profileId は作成後に変更できません。
通知プロファイルを表示または編集する [#view-edit]
-
NTT CPaaS Web インターフェイスにログインし、開発者ツール > サブスクリプション管理 に移動します。
-
[通知プロファイル] タブを開き、検索バーを使用してプロファイルを検索します。
-
プロファイルの横にある 3 つのドットのメニューを選択し、次を選択します。
- 表示: プロファイル構成の概要を表示する
- 編集: Webhook URL、応答の検証、セキュリティ、証明書、または詳細設定を変更します
-
変更を行い、更新 を選択します。
サブスクリプション API を使用して、次のことを行います。
- ページネーションですべての通知プロファイルを取得する
- プロファイルIDで特定の通知プロファイルを取得する
- プロファイルの Webhook URL、セキュリティ設定、証明書、または詳細設定を更新する
通知プロファイルの削除 [#delete]
-
NTT CPaaS Web インターフェイスにログインし、開発者ツール > サブスクリプション管理 に移動します。
-
[通知プロファイル] タブを開き、検索バーを使用してプロファイルを検索します。
-
プロファイルの横にある 3 つのドットのメニューを選択し、削除 を選択します。
通知プロファイルの削除 API エンドポイントを使用します。要求パスでプロファイル ID を指定します。
プロファイルを削除する前に、アクティブなサブスクリプションがプロファイルを使用していないことを確認してください。削除の依存関係を理解するには、サブスクリプションの階層と削除ルールを確認してください。
通知プロファイルに含まれるもの、スタンドアロン プロファイル、共有設定と独立設定の選択方法の詳細については、「サブスクリプション コンポーネント](/subscriptions/subscription-components#notification-profiles)を参照してください。
Webhook サブスクリプションの管理
サブスクリプションを作成および管理します。
認証設定の管理
Webhook エンドポイントを Basic、HMAC、または OAuth で保護します。
証明書の管理
エンドポイント認証の相互 TLS を有効にします。
サブスクリプションの階層と削除ルール
コンポーネントの関係と削除の依存関係。