開発者ポータル API リファレンス

API カタログを閲覧する

開発者ポータルの API リファレンス にアクセスし、API カードをクリックしてそのドキュメントを開きます。

各 API カードにはライフサイクルステータスチップが表示されます。バージョンがサポート終了日に近づいているか過ぎている場合、チップには日付ではなくカウントダウン（例：EOL in 45d）が表示されます。完全なライフサイクルの日付は、API 詳細ページのバナーに表示されます。詳細については、API ライフサイクルを参照してください。

インタラクティブなドキュメントを使用する

API リファレンスページでは、以下の操作ができます：

• サイドバーでエンドポイントを閲覧する。
• リクエストとレスポンスのスキーマや例を見る。
• エンドポイントをテストし、ブラウザから直接ライブリクエストを送信する。この機能を使用するには、ベアラートークンを生成する必要があります。詳細については、ベアラートークンを生成するを参照してください。
• 複数の言語でのコードスニペットを見る。
• MCP クライアントから直接 MCP 対応 API を使用する。

MCP 対応 API の使用

Model Context Protocol (MCP) をサポートする API は、そのリファレンスページに MCP タブとヘッダーに MCP (N tools) チップが含まれています。MCP タブには三つのセクションがあります：

• MCP Connection: すべての MCP 通信のための単一エンドポイントを示します：POST {gateway-url}{mcp-path}。すべての MCP 操作（初期化、ツールリスティング、ツールコール）は、この一つのエンドポイントを通じて JSON-RPC over HTTP POST で行われます。タブからエンドポイント URL をコピーします。認証は REST API と同じ OAuth 2.0 クライアントクレデンシャルベアラートークンを使用します。MCP には別の認証メカニズムはありません。トランスポートは Streamable HTTP です。
• Quick Start: TypeScript、Python、Java、cURL での接続例をコピーできます。
• Available Tools: MCP エンドポイントを通じて公開されるツールは、tools/list で発見可能で、tools/call を通じて名前で呼び出せます。

Postman との使用

Postman コレクションをダウンロードする

1. API の API リファレンスにアクセスします。
2. 右下の角にある ⋮ メニューをクリックしてスピードダイヤルを開きます。
3. Postman アイコンをクリックします。.json コレクションファイルが自動的にダウンロードされます。

Postman にインポートする

1. Postman を開き、Import をクリックします。
2. ダウンロードした .json ファイルを選択します。

コレクションには、リソースごとにフォルダに整理されたすべてのエンドポイント、パラメータ、リクエストボディが含まれています。

コレクションの認証

コレクションは、ベアラートークン認証のために {{access_token}} 変数を使用します。構成するには：

1. ベアラートークンを生成する。
2. Postman で Collection Variables を開きます。
3. access_token の値を生成したトークンに構成します。

コレクション内のすべてのリクエストには自動的に Authorization: Bearer {{access_token}} が含まれます。

API リファレンスからベアラートークンを生成する

トークンは2時間後に期限切れになります。

サインインしているユーザー（推奨）

サインインしており、API に対してアクティブなサブスクリプションを持つ登録アプリケーションがある場合は、この方法を使用します。

1. アクションを展開し、エンドポイントを選択します。
2. 右下の角にある ⋮ メニューをクリックし、次に Bearer Token キーアイコンをクリックします。
3. ドロップダウンからアプリケーションを選択し、Generate Token をクリックします。
4. Copy Token をクリックしてドロワーを閉じます。
5. トークンをアクション画面の Token フィールドに貼り付け、必要なパラメータを入力し、Send API Request をクリックします。

クライアントクレデンシャルを使用する

CI/CD パイプライン、サービスアカウント、または開発者ポータルを通じてサインインせずに client_id と client_secret を持っている任意のコンテキストでこの方法を使用します。

1. 任意の API ドキュメントページを開きます。
2. 右下の角にある ⋮ メニューをクリックし、次に Bearer Token キーアイコンをクリックします。
3. アプリケーションドロップダウンから Manual credentials を選択します。
4. client_id と client_secret を入力します。
5. 必要に応じてスコープを入力します。
6. Generate Token をクリックします。
7. 返されたトークンをコピーします。

サブスクリプションが付与するスコープのみを要求できます。開発者ポータルがスコープを拒否した場合は、サブスクリプションが必要なアカウントおよびプロファイルアクセスを含んでいることを確認してください。スコープの形式とコンポーネントの詳細については、Scopesを参照してください。

トークンの詳細

一般的なエラーのトラブルシューティング