API キーの管理

CPaaS X でアプリケーション、エンティティ、エンドポイント、チャネルごとにアクセスを制御するためのスコープ付き API キーを作成します。スコープキーが重要な理由とスコープのしくみの概念の概要については、「CPaaS X セットアップのセキュリティ保護」を参照してください。APIキーの一般的な概念と認証方法については、API認証を参照してください。既存のキーを管理する(表示、更新、無効化)には、 APIキー管理ページまたはアカウント管理APIを使用します。

前提条件 [#prerequisites]

スコープ付き API キーを作成するには、次のものが必要です。

CPaaS X を有効にしたアクティブな NTT CPaaS アカウント。
既に作成されているアプリケーションとエンティティ(キーのスコープを設定する場合)。アプリケーションとエンティティの管理を参照してください。

スコープ付き APIキーを作成する [#create-a-scoped-api-key]

NTT CPaaS Webインターフェイスで、開発者ツール > APIキーに移動します。
APIキーの作成を選択します。
わかりやすい Name を入力します (例: customer-a-sms-key)。
必要に応じて、自動キーローテーションの 有効期限 を設定します。
必要に応じて、許可された IP アドレス を追加して、使用を特定の IP に制限します。
API スコープ で、必要なアクセス許可を選択します。
- 一般: message:send, inbound-message:read。
- チャネル: チャネル(SMS、メール、WhatsAppなど)と操作(送信、ログの読み取り)で選択します。
- プラットフォーム: sending-strategy:manage、metrics:manage など。
オプションで、[アプリケーションとエンティティ] で [アプリケーションとエンティティの追加] を選択して、キーを特定のアプリケーション/エンティティにリンクして、CPaaS X 分離を行います。
作成を選択します。

重要

APIキーを安全に保存します。作成時に一度だけ表示されます。紛失した場合は、新しいキーを作成します。

もっと詳しく知る

使用可能な API スコープの完全なリストと、特定のエンドポイントへのアクセスを制御する方法については、API スコープを参照してください。

APIキーの制限 [#api-key-restriction]

API キーを特定のアプリケーションまたはエンティティに制限して、アクセスがアプリケーションまたはエンティティレベルで制御されるようにすることができます。

CPaaS X API key restriction diagram showing how different API keys map to specific entities

たとえば、エンティティスコープのキーを別のエンティティで使用しようとすると、不正アクセス応答を受け取ります。ただし、プライマリ APIキーは、すべてのパブリックエンドポイントにアクセスできるため、両方のリクエストで引き続き使用できます。

CPaaS X API key restriction example showing unauthorized access when using wrong entity key

もっと詳しく知る

認証情報の保存、IP セーフリスト、および一般的な API セキュリティに関するベストプラクティスについては、セキュリティに関する推奨事項を参照してください。

サポートされているエンドポイント [#supported-endpoints]

スコープ付き API キーは、Customer Engagement (Conversations、People)、チャネル (SMS、Email、WhatsApp、Voice など)、プラットフォーム (メトリック、送信戦略管理) の 3 つのカテゴリで特定の API エンドポイントへのアクセスを制限します。

関連ページ

CPaaS X セットアップを保護する
スコープの種類、ディメンション、およびそれぞれを使用するタイミング。

アプリケーションとエンティティ
コアコンセプトと組織階層。

Webhook サブスクリプション
エンティティごとのリアルタイム配信通知。