> ## Documentation Index
> Fetch the complete documentation index at: https://waffo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman コレクション

> Postman コレクションを使用して Waffo API を素早くテストします。

Postman コレクションには、Waffo のすべての API について事前設定されたリクエストが含まれており、素早くテストを実行できます。

## 入手方法

Sandbox 環境用の Postman Collection JSON ファイルをダウンロードしてください：

<a href="/docs/files/developer-docs/postman/Waffo-acquiring-api-demo-sandbox-onetimepayment.postman_collection.json" download="Waffo-acquiring-api-demo-sandbox-onetimepayment.postman_collection.json">Postman Collection をダウンロード</a>

ブラウザでプレビューが開く場合は、リンクを右クリックして **名前を付けてリンク先を保存** を選択し、`.postman_collection.json` のファイル名を保持してください。

## インポート方法

<Steps>
  <Step title="Postman を開く">
    Postman で **Import → Upload Files** を選択します。
  </Step>

  <Step title="ファイルをアップロード">
    ダウンロードした Collection JSON ファイルを選択します。
  </Step>

  <Step title="環境変数を設定">
    以下の環境変数を設定します。
  </Step>
</Steps>

## 環境変数

| 変数            | 説明                                     | 例の値                             |
| ------------- | -------------------------------------- | ------------------------------- |
| `base_url`    | API ベース URL                            | `https://api-sandbox.waffo.com` |
| `api_key`     | API キー                                 | Dashboard から取得                  |
| `merchant_id` | 加盟店 ID                                 | `M000001`                       |
| `signature`   | リクエスト body の SHA256WithRSA 署名 (Base64) | リクエスト送信前に生成                     |

## 含まれるエンドポイント

| エンドポイント        | パス                                         |
| -------------- | ------------------------------------------ |
| 決済作成           | `POST /api/v1/order/create`                |
| 決済照会           | `POST /api/v1/order/inquiry`               |
| 注文キャンセル        | `POST /api/v1/order/cancel`                |
| 返金リクエスト        | `POST /api/v1/order/refund`                |
| 返金照会           | `POST /api/v1/refund/inquiry`              |
| サブスクリプション作成    | `POST /api/v1/subscription/create`         |
| サブスクリプション照会    | `POST /api/v1/subscription/inquiry`        |
| サブスクリプションキャンセル | `POST /api/v1/subscription/cancel`         |
| サブスクリプション変更    | `POST /api/v1/subscription/change`         |
| 変更照会           | `POST /api/v1/subscription/change/inquiry` |
| サブスクリプション管理    | `POST /api/v1/subscription/manage`         |
| 加盟店設定照会        | `POST /api/v1/merchantconfig/inquiry`      |
| 決済手段設定照会       | `POST /api/v1/paymethodconfig/inquiry`     |

## 署名設定

このコレクションには `X-SIGNATURE: {{signature}}` Header が事前設定されています。リクエスト送信前に、加盟店の秘密鍵で raw JSON body に SHA256WithRSA 署名を行い、Base64 の結果を `signature` 変数に設定してください。

リクエスト body を変更した場合は、署名を再生成してください。本番の秘密鍵を Postman Collection ファイルに保存しないでください。