用語定義
3つの連携モード

オンラインデモサイト
これら3つの連携モードが実際にどのように機能するかは、デモサイトでエンドツーエンドの連携フローを確認できます。
連携モード比較
どちらがどのエンドポイントを提供するか
Waffo が提供するのは 2 つのエンドポイントと 1 つの Webhook だけで、API リファレンスのポイントチャージグループに掲載しています。 サプライヤー側のエンドポイントはすべて任意連携です。本ドキュメントに記載する仕様はサンプルであり、すでに同等の API をお持ちの場合は、既存の API ドキュメントを Waffo Point Topup に提供すれば、Waffo がその既存インターフェースに対応します。モード C の最小構成は「
GET /redirect 署名リダイレクト + 履行結果通知 Webhook」で、履行 API を実装しない形です。この場合 Webhook が返すのは PAY_SUCCESS と PAYMENT_FAILED のみで、PAY_SUCCESS を受け取った後にサプライヤー側で発送処理を行います。モード別の準備
モード A:オフラインポイントコードインポート
モード A:オフラインポイントコードインポート
サプライヤーから必要な資料:詳細はモード A:オフラインポイントコードインポートを参照してください。
連携手順:
1
ポイントコードデータの提供
サプライヤーがポイントコードデータをオフラインで提供(Excel/CSV)。
2
在庫へのインポート
Waffo Point Topup がポイントコードを在庫システムにインポート。
3
購入リンクの受領
Waffo Point Topup がサプライヤーに購入リンクを提供。
4
リンクの設置
サプライヤーが自社ウェブサイトに購入リンクを埋め込み。
5
発送
ユーザー購入後、Waffo Point Topup がポイントコードをユーザーのメールに送信。
6
精算
Waffo Point Topup が定期的な精算レポートを提供。
モード B:ポイントコード取得 API
モード B:ポイントコード取得 API
サプライヤーから必要な資料:詳細はモード B:ポイントコード取得 APIを参照してください。
連携手順:
1
RSA 公開鍵の交換
サプライヤーと Waffo Point Topup が RSA 公開鍵を交換。
2
API 資料の提供
サプライヤーが API キーと API ドキュメントを提供。
3
共同テスト
ポイントコード取得 API を共同でテスト。
4
購入リンクの受領
Waffo Point Topup が購入リンク(静的リンク)を提供。
5
リンクの設置
サプライヤーが自社ウェブサイトにリンクを埋め込み。
6
本番稼働
本番環境でローンチ。
モード C:即時履行 API
モード C:即時履行 API
サプライヤーから必要な資料:詳細はモード C:即時履行 APIを参照してください。
連携手順:
1
RSA 公開鍵の交換
サプライヤーと Waffo Point Topup が RSA 公開鍵を交換。
2
鍵と資料の提供
サプライヤーが
SECRET_KEY、API キー、API ドキュメントを提供。3
URL 署名の実装
サプライヤーが URL 署名ロジックをバックエンドで実装。
4
共同テスト
URL 署名検証、即時履行 API、照会 API(任意)、履行結果通知 Webhook(任意)をテスト。
5
署名付きリンクの設置
サプライヤーがウェブサイトに署名付きリダイレクトリンクを統合。
6
本番稼働
本番環境でローンチ。
次のステップ
モード A:オフラインポイントコードインポート
ポイントコード CSV 形式、購入リンクの設置、精算レポート。
モード B:ポイントコード取得 API
リアルタイム取得のリクエスト・レスポンス項目と冪等性の要件。
モード C:即時履行 API
URL 署名リダイレクト、即時履行、即時履行結果照会。
API 共通仕様
メッセージ構造、RSA 署名と検証、エラーコード、鍵の生成。