Quote3D ドキュメントへようこそ!⏳

Postmanコレクション

Quote3D APIのすべてのエンドポイントをすばやくテストするために、当社のPostmanコレクションをインポートしてください。このコレクションには、サンプルリクエストと環境変数を含むすべてのエンドポイントが含まれています。

コレクションのダウンロード

Postmanコレクションと環境ファイルをダウンロードして、すぐに始めましょう。

Postmanコレクション

生成されていません

すべてのエンドポイント、リクエスト例、およびレスポンススキーマを含む完全なAPIコレクション。

コレクションを生成して実行します。 npm run generate:postman

環境変数

生成されていません

ベースURLとAPIトークン変数が含まれる環境テンプレートです。

コレクションを生成して実行します。 npm run generate:postman

インポート方法

  1. コレクションをダウンロード - 上記の「コレクションをダウンロード」ボタンをクリックして、Postmanコレクションファイルをダウンロードしてください。
  2. 環境ファイルをダウンロード - 「環境ファイルをダウンロード」ボタンをクリックして、環境変数ファイルをダウンロードしてください。
  3. コレクションをインポート - Postmanを開き、左上の「インポート」をクリックして、ダウンロードしたコレクションファイルを選択してください。
  4. 環境ファイルをインポート - Postmanで、環境変数に移動し、「インポート」をクリックして、ダウンロードした環境ファイルを選択してください。
  5. トークンを設定 - インポートした環境を選択し、api_token変数を実際のAPIトークンで更新してください。
  6. テストを開始 - コレクション内のすべてのリクエストは、環境変数を自動的に使用します。これで、任意のAPIエンドポイントをテストできます!

環境変数

Postman 環境には以下の変数が含まれています:

変数デフォルト値説明
base_urlhttps://api.quote3d.comすべてのAPIリクエストのベースURL (https://api.quote3d.com/v2 を使用してください)
api_tokenYOUR_TOKEN_HEREAPIベアラートークン (実際のトークンに置き換えてください)

ヒントとベストプラクティス

  • リクエストを行う前に、正しい環境を選択していることを確認してください
  • api_token変数を実際のトークンで更新してください
  • 異なる環境(開発、ステージング、本番環境)のために複数の環境を作成できます
  • Postmanのコレクションランナーを使用して、一度に複数のエンドポイントをテストできます
  • コレクション内のレスポンス例を確認して、期待されるレスポンス形式を理解してください

お困りですか?

コレクションのインポートで問題が発生した場合は、コード例を確認するか、インタラクティブなテストのためにAPI Playgroundを試してみてください。