NTT CPaaS 開発者ドキュメント

このドキュメントは、NTT CPaaS を使った開発を最短で前に進めるために、APIの仕様確認と導入手順の理解をひとつのサイトにまとめたものです。

APIエンドポイントやパラメータを正確に確認したいときは APIリファレンス、サービス導入の流れや運用まで含めて理解したいときは スタートアップガイド、という使い分けを前提に構成しています。目的に応じて読み分けることで、必要な情報に素早くたどり着けます。

このサイトでできること

• APIリファレンスで、SMS、Voice、メール、2FA 等それぞれの仕様、リクエスト例、レスポンス例を確認できます。
• スタートアップガイドで、サービスごとの導入手順、事前準備、実装、運用の流れを段階的に追えます。
• 利用するサービスに絞って読み進められるため、関係のないチャネルの情報を読み込まずに学習できます。
• 開発初期の検証から本番運用の検討まで、同じ導線の中で確認できます。

読み方の目安

APIリファレンスを使う場面

次のような場面では APIリファレンスから入るのが効率的です。

• まずリクエストを1本通してみたい
• エンドポイント、必須パラメータ、認証方法を確認したい
• 実装中にレスポンス形式やエラー内容を見直したい
• サービスごとの差分を比較したい

対象サービスが決まっている場合は、必要な API だけを先に開いて確認してください。

スタートアップガイドを使う場面

次のような場面では スタートアップガイドから読み始めるのが適しています。

• どの準備が必要かを最初に整理したい
• 検証環境から本番運用までの全体像を把握したい
• ドメイン設定やIP設定など、API呼び出し以外の前提条件も含めて確認したい
• 運用時の注意点やチェックリストまで含めて抜け漏れなく進めたい

共通の入口は 概要 です。導入項目が多いサービスでは、概要から順に追うことで全体像をつかみやすくなります。

サービスを絞って効率的に読む

NTT CPaaS では、利用サービスごとに見るべき情報が大きく変わります。最初から全体を通読するよりも、対象サービスをひとつ決めて、その範囲で APIリファレンスとスタートアップガイドを往復する読み方が効果的です。

例えば次の進め方を推奨します。

• SMS や Voice のように、まず API 呼び出しを試したい場合は APIリファレンスから入る
• メール のように、事前準備や運用設計の影響が大きい場合は スタートアップガイドの概要から入る
• 実装で詰まったら APIリファレンスに戻って仕様を再確認する
• 導入判断や運用設計を進める段階では スタートアップガイドで前提と注意点を補う

この読み方にすると、必要な情報をその都度取りにいけるため、学習コストを抑えながら実装を前に進められます。