Omise Postman コレクション
公式 Omise Postman コレクションは 100+ のエンドポイントの事前設定された API リクエストの包括的なセットを提供し、リソースタイプ別に整理されています。Omise API を迅速にテストし、統合の問題をデバッグし、テストワークフローを自動化できます。
概要
Postman とは?
Postman は、API 構築、テスト、ドキュメント化のプロセスを簡素化する人気のある API 開発プラットフォームです。以下を提供：
- インタラクティブリクエストビルダー - ユーザーフレンドリーなインターフェース
- コレクション管理 - 関連リクエストを整理
- 環境変数 - テスト及び本番設定を管理
- 自動テスト - テストを記述及び実行
- チーム協力 - チームメンバーと共有
- CI/CD統合 - デプロイパイプラインに統合
インストール
前提条件
- Postman アカウント - postman.com で無料アカウント
- Omise アカウント - API キー付きアクティブなアカウント
- Postman アプリ - デスクトップアプリまたはウェブ版
インストール手順
- Postman を開く
- インポートボタンをクリック
- 公式 Omise Postman ワークスペースからコレクションをインポート
- 環境変数を設定（API キー）
- テスト開始
環境変数の設定
環境変数は、テスト及び本番環境を簡単に切り替えられます。
テスト環境を作成
- 環境アイコンをクリック
- 「+」で新規環境を作成
- 環境に名前を付ける - 「Omise Test」
- 変数を追加：
| 変数 | タイプ | 値 |
|---|---|---|
base_url | default | https://api.omise.co |
secret_key | secret | skey_test_your_secret_key |
public_key | default | pkey_test_your_public_key |
api_version | default | 2019-05-29 |
- 環境を保存
利用可能なエンドポイント
Omise Postman コレクションにはすべての API エンドポイントがリソースタイプ別に整理されています。
請求
| エンドポイント | メソッド | 説明 |
|---|---|---|
| List Charges | GET | 請求ページネーションリストを取得 |
| Create Charge | POST | 新しい請求を作成 |
| Get Charge | GET | 特定の請求を取得 |
| Update Charge | PATCH | 請求メタデータを更新 |
| Capture Charge | POST | 認可された請求をキャプチャ |
顧客
| エンドポイント | メソッド | 説明 |
|---|---|---|
| List Customers | GET | すべての顧客を取得 |
| Create Customer | POST | 新しい顧客を作成 |
| Get Customer | GET | 顧客詳細を取得 |
| Update Customer | PATCH | 顧客情報を更新 |
| Delete Customer | DELETE | 顧客を削除 |
カード
| エンドポイント | メソッド | 説明 |
|---|---|---|
| List Cards | GET | 顧客カードを一覧表示 |
| Get Card | GET | カード詳細を取得 |
| Update Card | PATCH | カード情報を更新 |
| Delete Card | DELETE | カードを削除 |
返金
| エンドポイント | メソッド | 説明 |
|---|---|---|
| List Refunds | GET | 請求の全返金を一覧表示 |
| Create Refund | POST | 全額または部分返金を発行 |
| Get Refund | GET | 返金詳細を取得 |
テストワークフロー
ワークフロー 1：完全な 支払いフロー
このワークフローは、請求を作成し、結果を確認します。
- トークンを作成 - カード情報をトークン化
- 請求を作成 - トークンを使用して請求を作成
- 請求を取得 - 請求が成功したことを確認
- 取引をリスト表示 - 取引履歴を表示
ワークフローを実行：
- 「Workflows」フォルダを開く
- 「Complete Payment Flow」を選択
- 「Run」ボタンをクリック
- Collection Runner で結果を表示
CI/CD統合
Newman を使用して Omise API テストをCI/CDパイプラインに統合します。
Newman をインストール
npm install -g newman
テストを実行
newman run omise-collection.json \
--environment omise-test-env.json \
--reporters cli,json
GitHub Actions統合
.github/workflows/api-tests.yml を作成：
name: API Tests
on:
push:
branches: [ main, develop ]
jobs:
api-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: '18'
- run: npm install -g newman
- run: newman run tests/omise-collection.json \
--environment omise-test-env.json
ベストプラクティス
- テストモードを常に使用 - 本番環境ではテストキーは使用しない
- エラーシナリオをテスト - 失敗ケースを処理
- テストと本番データを分離 - 異なるデータベースを使用
- テストデータを定期的にクリア - 古いテスト取引をアーカイブ
FAQ
Omise Postman コレクションに含まれるエンドポイント数はいくつですか？
100以上のエンドポイント（請求、顧客、カード、返金、送金など）
本番環境で Postman を使用できますか？
はい、ですが慎重に。テストと本番環境に別々の環境を設定してください。
Newman とは何ですか？
Postman のコマンドラインコレクションランナー。CI/CDパイプラインに統合できます。
関連リソース
- API リファレンス - 完全な Omise API ドキュメント
- 認証ガイド - API キー管理
- テストガイド - テスト戦略
- Postman ドキュメント - Postman 学習
次のステップ
- コレクションをインポート
- 環境変数を設定
- テストキーで API をテスト
- 本番キーに切り替え
- CI/CD に統合