ドキュメント
Updated:
これらのツールは、同梱されているProxy-Seller APIのドキュメントを読み取ります。お客様のアカウントには一切アクセスせず、クライアントAPIキーなしで動作します。
権限:docs:read
対象範囲。 これらのツールは、スナップショットに基づいて回答します。クライアントAPI v2 ドキュメント(英語版):公開されているすべての操作に関するリファレンスページ、ガイド、およびPython、Node.js、PHP、Go、Java用のSDKスニペット。スナップショットは、ドキュメント自体が変更されてから数分後に更新されます。
このグループでは
ツール | 機能の説明 | |
|---|---|---|
🟢 | APIドキュメントを検索し、短いスニペットを返す。 | |
🟢 | ドキュメントのページ1つ、またはその中の1つのセクションを読んでください。 | |
🟢 | APIの操作一覧を、メソッド、パス、概要とともに記載してください。 | |
🟢 | 1つの操作に関する詳細情報:パラメータ、リクエスト本文、レスポンス、エラー、例、利用可能なSDK言語。 | |
🟢 | 操作に関する、すぐに使えるコード例。 | |
🟢 | 最新のドキュメントバージョンと、各バージョンで追加・変更・削除された内容。 |
ps_docs_search
🟢read-only ・ docs:read
APIドキュメントを検索し、短いスニペットを返す。
パラメータ | 種類 | 説明 |
|---|---|---|
| string | 自由記述、 |
|
| ドキュメントの種類は1つに限定してください |
| string[] | 以下のタグをすべて持つドキュメントのみ |
| 整数 | 検索結果の最大数、デフォルト |
ps_docs_get
🟢read-only ・ docs:read
ドキュメントのページ1つ、またはその中の1つのセクションを読んでください。
パラメータ | 種類 | 説明 |
|---|---|---|
| string | ドキュメントID、例: |
| string | A |
ps_api_list_endpoints
🟢read-only ・ docs:read
APIの操作を、メソッド、パス、概要とともに一覧表示してください。非推奨の操作は、デフォルトで非表示にしてください。
パラメータ | 種類 | 説明 |
|---|---|---|
| string | 例: |
| string | 操作ID、タイトル、パスに対する部分文字列の抽出 |
|
| HTTPメソッド |
| boolean | デフォルト |
ps_api_get_endpoint
🟢read-only ・ docs:read
1つの操作に関する詳細情報:パラメータ、リクエスト本文、レスポンス、エラー、例、利用可能なSDK言語。非推奨となった操作については、それに代わる操作名も記載すること。
パラメータ | 種類 | 説明 |
|---|---|---|
| string | 例: |
ps_sdk_snippet
🟢read-only ・ docs:read
操作に関する、すぐに使えるコード例。
パラメータ | 種類 | 説明 |
|---|---|---|
| string | 例: |
|
| SDKの言語 |
ps_whats_new
🟢read-only ・ docs:read
ドキュメントの最新バージョンと、各バージョンで追加・変更・削除された内容。新しいものから順に表示。
パラメータ | 種類 | 説明 |
|---|---|---|
| string | このバージョンより新しいもののみ |
| 文字列 (ISO 8601) | この日付以降のバージョンのみ |