メインコンテンツへスキップ

インテグレーション概要

Waffo Pancake は、アプリケーションに決済を直接統合するための強力な API と開発者ツールを提供します。

API アーキテクチャ

Waffo Pancake はハイブリッド API を採用しています:
  • REST (POST)/v1/actions/{domain}/{action} 経由のすべての書き込み操作
  • GraphQL/v1/graphql 経由のすべての読み取り操作
Your Application
    |
    +-- REST POST requests --> Create/Update/Delete
    |
    +-- GraphQL queries --> Read data

ベース URL

https://waffo-pancake-auth-service.vercel.app/v1

API Key

API Key はサーバー間リクエストを認証します。認証は SDK が自動的に処理します。

テスト用キー

test 環境用に作成。実際の課金なし。

本番用キー

prod 環境用に作成。実際の支払いを処理。

API Key の作成

1

開発者ページに移動

ダッシュボード > 開発者に移動します。
2

キーペアを生成

「生成」をクリックしてキーペアを作成します。公開鍵がサーバーに送信されます。
3

キーに名前を付ける

わかりやすいニックネームを付けます(例:「本番サーバー」)。
4

環境を選択

テストまたは本番環境を選択します。キーは環境固有です。
5

秘密鍵をダウンロード

秘密鍵をダウンロードし、安全に保管してください。一度しか表示されません。

API Key エンドポイント

エンドポイント説明
POST /v1/actions/api-key/create-key新しい API Key を作成
POST /v1/actions/api-key/delete-key既存の API Key を削除
秘密鍵をクライアント側コード、バージョン管理、または公開リポジトリに公開しないでください。

Webhooks

Webhooks は、イベント発生時にサーバーにリアルタイムで通知します。

セットアップ

1

Webhooks に移動

ダッシュボード > 設定 > Webhooks に移動します。
2

Webhook URL を入力

各環境に個別の Webhook URL を設定します:
  • テスト Webhook URL — テストモードからのイベントを受信
  • ライブ Webhook URL — 本番モードからのイベントを受信
3

設定を保存

設定を保存します。エンドポイントはすべての Webhook イベントの受信を開始します。
イベントフィルタリングはありません — Webhook エンドポイントはすべてのイベントを受信します。サーバー側のハンドラーでイベントタイプによるフィルタリングを行ってください。

Webhook 署名の検証

Webhooks 設定ページに Webhook 公開鍵が表示されます。このキーを使用して、受信した Webhook ペイロードが Waffo Pancake から送信されたものであり、改ざんされていないことを検証できます。

主要エンドポイント

ストア

エンドポイント説明
POST /v1/actions/store/create-storeストアを作成
POST /v1/actions/store/update-storeストア情報を更新
POST /v1/actions/store/delete-storeストアを論理削除

商品

エンドポイント説明
POST /v1/actions/onetime-product/create-product単発商品を作成
POST /v1/actions/onetime-product/update-product単発商品を更新(新バージョンを作成)
POST /v1/actions/onetime-product/update-status単発商品の有効化/無効化
POST /v1/actions/onetime-product/publish-product単発商品を環境間で公開
POST /v1/actions/subscription-product/create-productサブスクリプション商品を作成
POST /v1/actions/subscription-product/update-productサブスクリプション商品を更新
POST /v1/actions/subscription-product/update-statusサブスクリプション商品の有効化/無効化
POST /v1/actions/subscription-product/publish-productサブスクリプション商品を環境間で公開

注文

エンドポイント説明
POST /v1/actions/onetime-order/create-order単発チェックアウトセッションを作成
POST /v1/actions/onetime-order/cancel-order保留中の単発注文をキャンセル
POST /v1/actions/subscription-order/create-orderサブスクリプションチェックアウトセッションを作成
POST /v1/actions/subscription-order/cancel-orderサブスクリプションをキャンセル
POST /v1/actions/subscription-order/change-productサブスクリプション商品のアップグレードまたはダウングレード

返金

エンドポイント説明
POST /v1/actions/refund-ticket/create-ticket返金をリクエスト

データクエリ

エンドポイント説明
POST /v1/graphql任意のデータを照会(ストア、商品、注文、支払い等)

セキュリティのベストプラクティス

環境変数

秘密鍵は環境変数に保管し、コード内には含めないでください。

キーローテーション

定期的にキーをローテーションし、特にチーム変更後は必ず行ってください。

キーの分離

テスト環境と本番環境で異なる API Key を使用してください。

安全な保管

プラットフォームのシークレット管理機能を使用して秘密鍵を保管してください。

次のステップ

インテグレーション概要

ステップバイステップのインテグレーションガイド。

API リファレンス

完全なエンドポイントドキュメント。