アプリケーションとエンティティ
CPaaS Xは、アプリケーションとエンティティという2つの独立したビルディングブロックを中心にマルチテナント通信を編成します。このページでは、各概念が何を表しているのか、どのように連携し、どのように作成および管理されるのかについて説明します。
アプリケーションは、「本番SMS」や「マーケティングキャンペーン」などの環境またはユースケースを表します。エンティティ は、トラフィックとデータが他のすべてのエンティティから完全に分離されたままのテナント、顧客、ブランド、またはビジネス ユニットです。アプリケーションはあなたが何をしているのかを整理し、エンティティはあなたがそれを行っているのかを誰のために整理するかを整理する」という2つを組み合わせます。
2つのコアコンセプト [#two-core-concepts]
アプリケーション [#applications-two-core-concepts]
アプリケーションは、本番システム、マーケティングプログラム、テスト設定など、アカウント内の環境またはユースケースを表します。組織構造に合わせて複数のアプリケーションを作成できます。
各アプリケーションには以下が含まれます:
- 制御下にある一意の
applicationId識別子。 - 独立したレポートと使用状況の追跡。
アプリケーション例:
production: ライブの顧客コミュニケーションmarketing-campaigns: すべてのマーケティングアウトリーチstaging: 本番前のテスト環境
組織パターン:
アプリケーションは、ビジネス ニーズに応じて複数の方法で編成できます。
- 環境別: 「本番環境」、「ステージング」、「テスト」のアプリケーションを分離します。
- ユースケース別: コミュニケーション目的(「認証」、「通知」、「マーケティング」)でグループ化します。
- 地域別: 地域またはデータセンターごとに作成します (
us-datacenter、eu-datacenter)。 - カスタムパターン: これらのいずれかを組み合わせるか、独自の構造を作成します。
キーポイント: アプリケーションは独立しています。あるアプリケーションで発生することは、別のアプリケーションには影響しません。
技術的な理由から、NTT CPaaSアカウントを設定すると「デフォルト」アプリケーションが自動的に作成されます。デフォルトのアプリケーションを明示的に使用する必要はありませんが、アプリケーションリストと API 応答に表示されます。ビジネス要件に応じて、必要に応じて追加のアプリケーションを作成できます。
エンティティ [#entities-two-core-concepts]
エンティティ はテナントです。これは、特定のクライアント、地域オフィス、製品層など、アカウント内の顧客、部署、または組織部門を表します。
主な特徴:
- 独自に作成。作成時にアプリケーションの割り当ては必要ありません。
- 送信時にアプリケーションが指定されていない場合、エンティティには「デフォルト」アプリケーションがタグ付けされます。
- 送信戦略およびメッセージ送信API呼び出しを介してアプリケーションに接続されます。
- 作成にハードリミットはありません。安全対策により、悪用が防止されます。
- 個別のデータと使用状況の追跡により、他のエンティティから完全に分離されます。
各エンティティが提供するもの:
- 制御下にある一意の
entityId識別子。 - 独立したレポートと使用状況の追跡。
- 他のエンティティからのデータを完全に分離します。
エンティティの例:
- 個々の顧客アカウント(
customer-a、customer-b) - 事業部門(北米部門、欧州部門)
- 製品レベル ('Tier-Premium'、'Tier-Standard')
組織パターン:
一般的なエンティティ構造には、次のものがあります。
- 顧客別: 各顧客またはブランドを個別のエンティティとして (
customer-a、customer-b、company-c)。 - 地域/子会社別: 地域オフィスまたは事業子会社 (
office-us、office-eu、office-uk)。 - ビジネスユニット別: 社内部門またはビジネスライン(「マーケティングチーム」、「サポートチーム」)。
キーポイント: エンティティは完全に分離されています。各エンティティは、独自のデータのみを表示できます。
アプリケーションとエンティティの連携方法 [#how-applications-and-entities-work-together]
アプリケーションとエンティティには、いくつかの運用特性があります。
| 機能 | 仕組み |
|---|---|
| 報告 | applicationId と entityId はどちらも、アプリケーションとエンティティごとに追跡するために、配信レポートとコールバック イベントに表示されます。 |
| スマートルーティング | sending strategies とリソース アソシエーションを一緒に使用して、アプリケーションとエンティティをリソースとペアにするルーティング ルールを設定します。 |
| APIキーのスコープ設定 | API キーは、オプションで特定のアプリケーション + エンティティの組み合わせにスコープを設定して、分離と保護を強化することができます。 |
| データの分離 | 独立した使用状況の追跡とレポートにより、アプリケーションとエンティティを完全に分離します。 |
作成と管理 [#creation-and-management]
アプリケーションおよびエンティティは、Web インターフェイス、API、または MCP サーバーを介して作成できます。それぞれに、作成後に変更できない一意の ID と、オプションの表示名が必要です。
- WebインターフェイスとAPI: 詳細な手順については、アプリケーションとエンティティの管理を参照してください。
- MCP サーバー: プログラムによるフローについては、NTT CPaaS MCP ドキュメント および GitHub リポジトリ↗ を参照してください。
さらに、エンティティは API 呼び出し中に自動的に作成できます。存在しない entityId を含むメッセージを送信すると、セーフガードを使用して自動的に作成されます。セーフガード付き自動作成を参照してください。
アプリケーションとエンティティの両方がすべての履歴データを保持するため、必要に応じて構造を再編成できます。
セーフガードによる自動作成 [#automatic-creation-creation-and-management]
使用する前に、すべてのエンティティを事前に作成する必要はありません。存在しない entityId を含むメッセージを送信すると、CPaaS X は自動的にメッセージを作成します。
- その
entityIdを使用して新しいエンティティが作成されます。 - アプリケーションが指定されていない場合、エンティティは「デフォルト」アプリケーションでタグ付けされます。
- エンティティ識別子は、レポートと分析にすぐに表示されます。
アプリケーションは、Web インターフェイス、API、または MCP サーバーを介して明示的に作成する必要があります。存在しない applicationId を含むメッセージを送信すると、メッセージは拒否されます。
自動作成には、過剰な識別子の偶発的な作成、アカウント構造をフラッディングしようとする悪意のある試み、未使用のエンティティの制御不能な急増を防ぐための保護手段が含まれます。本番システムの場合は、明示的な API または Web インターフェイスの作成を使用します。自動作成は、開発中の動的な顧客固有のエンティティに最適です。
アプリケーションとエンティティの管理
作成、更新、削除の手順を順を追って説明します。
CPaaS Xを使い始める
エンドツーエンドのセットアップチュートリアル。
リソースを理解する
リソースの種類、ライフサイクル、および課金。
送信戦略
リソースの関連付けとインテリジェントなルーティング。
CPaaS X セットアップを保護する
API キーとセキュリティのベスト プラクティス。