アプリケーションとエンティティを管理する
Web インターフェースまたは API を使用して、CPaaS X アプリケーションおよびエンティティーを管理します。変更は、Web インターフェイスと API の間ですぐに同期されます。概念的な概要については、「アプリケーションとエンティティ」を参照してください。
アプリケーションとエンティティの作成と表示 [#create-applications-and-entities]
コミュニケーションを整理するアプリケーションと、顧客を表すエンティティを作成します。
アプリケーションを作成するには:
- NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
- [アプリケーション] タブを選択します。
- アプリケーションの作成 を選択します。
- アプリケーション ID フィールドに、永続的な ID を入力します (例:
production、marketing-campaigns)。IDは後から変更できません。 - オプションで、アプリケーション名 フィールドに表示名を入力します (たとえば、'運用環境')。
- アプリケーションの作成 を選択します。
エンティティを作成するには:
- NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
- [エンティティ] タブを選択します。
- エンティティの作成 を選択します。
- エンティティ ID フィールドに、永続的な ID を入力します (例:
customer-a、division-northamerica)。IDは後から変更できません。 - 必要に応じて、エンティティ名 フィールドに表示名を入力します (例: '顧客 A アカウント')。
- エンティティの作成 を選択します。
アプリケーションとエンティティを表示するには:
- NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
- アプリケーションタブとエンティティタブを切り替えて、リストを参照します。
- 検索オプションとフィルター オプションを使用して、特定のアプリケーションまたはエンティティを検索します。
Application and Entity Management API を使用して、次のことを行います。
- アプリケーションの作成 または エンティティの作成
- ページネーションを使用してすべてのアプリケーションを取得するか、すべてのエンティティを取得する
- 特定のアプリケーションを取得するか、ID で特定のエンティティを取得する
applicationId と entityId は、作成後に変更することはできません。エンティティは、メッセージ送信で参照されると、まだ存在しない場合に自動作成されます。
アプリケーションとエンティティの更新 [#update-applications-and-entities]
アプリケーションとエンティティの表示名を変更します。applicationId と entityId は、作成後に変更することはできません。
アプリケーションを更新するには:
- NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
- [アプリケーション] タブを選択します。
- アプリケーション ID リンクを選択して、詳細ページを開きます。
- アプリケーションの編集 を選択します。
- 必要に応じて、アプリケーション名フィールドを更新します。
- Save (保存) を選択します。
エンティティを更新するには:
- NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
- [エンティティ] タブを選択します。
- エンティティ ID リンクを選択して、詳細ページを開きます。
- エンティティの編集 を選択します。
- 必要に応じて エンティティ名 フィールドを更新します。
- Save (保存) を選択します。
Application and Entity Management API を使用して、次のことを行います。
- アプリケーションを変更する: 表示名を変更する
- エンティティの変更: 表示名を変更する
変更できるのは表示名のみです。applicationId と entityId は永続的です。
アプリケーションとエンティティの削除 [#delete-applications-and-entities]
不要になったアプリケーションまたはエンティティを削除します。削除は永続的です。
アプリケーションを削除するには:
- NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
- [アプリケーション] タブを選択します。
- リストでアプリケーションを見つけます。
- 削除アイコンを選択します
. - 確認ダイアログで、[確認] を選択します。
エンティティを削除するには:
- NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
- [エンティティ] タブを選択します。
- リストでエンティティを見つけます。
- 削除アイコンを選択します .
- 確認ダイアログで、[確認] を選択します。
Application and Entity Management API を使用して、次のことを行います。
リンクされたリソースは application = default と 'エンティティ = null' にリセットされます。削除する前に、構成を再割り当てします。
削除は元に戻せません。リンクされたリソースは application = default と 'エンティティ = null' にリセットされます。削除する前に、関連する構成 (リソースの関連付け、受信メッセージ構成、サブスクリプション、ボット、API キー) を他のアプリケーションまたはエンティティに再割り当てします。
もっと詳しく知る利用可能なすべてのエンドポイント、要求/応答スキーマ、およびフィルタリング オプションについて、完全な アプリケーションおよびエンティティ管理 API を調べてください。
アプリケーションとエンティティ
コアコンセプトと組織階層。
CPaaS Xを使い始める
エンドツーエンドのセットアップチュートリアル。
送信戦略の設定
リソースの関連付けとルーティングルールを設定します。
CPaaS X セットアップを保護する
アクセス制御の API キーのスコープを設定します。