ベースURLとAPIキー

目的

ベースURL は、NTT CPaaS のテナントごとに割り当てられた固有のサブドメインです。
すべての API リクエストのエンドポイントは、このベースURL を組み合わせて構成されます。

https://{baseURL}.ibapi.nttcpaas.com

例えば SMS 送信 API のエンドポイントは次のようになります。

https://{baseURL}.ibapi.nttcpaas.com/sms/3/messages

API キーは、NTT CPaaS の API を利用する際の「システム間認証パスワード」となる非常に重要な情報です。
API リクエストのたびに Authorization ヘッダーに付与し、認証に使用します。

NTT CPaaS は API キー認証のみ対応

NTT CPaaS の SMS 送信 API は Authorization: App {API_KEY} 形式の認証のみ対応しています。
Authorization: Basic ... 形式のベーシック認証はサポートしていません。誤って使用しないようご注意ください。

API キーは厳重に管理してください

API キーが漏洩すると、第三者がお客様のアカウントで SMS を送信できてしまいます。
ソースコードへのハードコードや、バージョン管理システムへのコミットは絶対に避けてください。

NTT CPaaSポータルページから、以下の手順でベースURL の取得と API キーの作成を行います。

NTT CPaaSマイページへログイン
NTT CPaaSマイページにアクセスし、管理者権限または開発者権限を持つアカウントでログインします。
NTT CPaaSの利用をスタート
「NTT CPaaSスタート」を選択し、NTT CPaaSポータルページにログインします。
API キー管理画面へ移動
NTT CPaaSポータルページのホームページの「ディベロッパー」タブを開きます。
この画面の「APIベースURL」欄に表示されている値がベースURLです。コピーして保存してください。
APIキーを作成する場合は「API キーを管理」を選択します。
新規 API キーの作成
「APIキーの作成」ボタンをクリックします。
管理しやすいよう、用途が明確に分かる名前（例：SMS_Production_Key、Trial_Testing_Keyなど）を入力して生成を完了します。

API キー生成後、画面に文字列が表示されます。

表示期間は生成後 2 日間のみです

セキュリティの観点から、API キーの文字列は生成直後の 2 日間 しか表示されない仕様です。
必ずコピーし、セキュアな環境（シークレット管理ツールなど）に保存してください。

API リクエストを送信する際は、エンドポイントにベースURL を、Authorization ヘッダーに API キーをそれぞれ指定します。

POST https://{baseURL}.ibapi.nttcpaas.com/sms/3/messages
Content-Type: application/json
Authorization: App YOUR_API_KEY_HERE

値	取得場所	使用箇所
`{baseURL}`	ポータルの API 設定画面	エンドポイント URL のサブドメイン部分
`YOUR_API_KEY_HERE`	ポータルの API キー管理画面	`Authorization: App ...` ヘッダー