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

​
開発者設定

開発者ページは、Waffo Pancake をアプリケーションと統合するためのツールを提供します。

​
APIキー

​
概要

APIキーは Waffo Pancake API へのサーバー間リクエストを認証します。

テストキー

  • test 環境用に作成
  • 開発に使用
  • 実際の課金なし
  • 本番データと分離

本番キー

  • prod 環境用に作成
  • 本番に使用
  • 実際の支払いを処理
  • 秘密鍵を安全に保管

​
キータイプ

キータイプユースケース説明
APIキーサーバーサイドのみ署名リクエスト、フルAPIアクセス

​
APIキー認証

API Key 認証は SDK が自動的に処理します。@waffo/pancake-ts をインストールし、Merchant ID と秘密鍵を提供するだけで、SDK がリクエストの署名を自動的に行います。
import { WaffoPancake } from "@waffo/pancake-ts";

const client = new WaffoPancake({
  merchantId: process.env.WAFFO_MERCHANT_ID!,
  privateKey: process.env.WAFFO_PRIVATE_KEY!,
});
クライアントサイドコード、バージョン管理、パブリックリポジトリで秘密鍵を公開しないでください。

​
APIキーの作成

1

開発者に移動

ダッシュボード —> 開発者 —> APIキー
2

「APIキーを作成」をクリック

APIキージェネレーターが開きます。
3

キーペアを生成

「生成」をクリックしてキーペアを作成。
  • 公開鍵がサーバーに送信されます
  • 秘密鍵はあなたが保管します
4

キーに名前を付ける

説明的な名前を付ける（例：「本番サーバー」）
5

環境を選択

テストまたは本番環境を選択。
6

秘密鍵をダウンロード

重要： 秘密鍵をダウンロードして安全に保存。
秘密鍵は一度だけ表示されます。安全に保存してください — API認証に必要です。

​
キーの管理

アクション説明
表示キー名、作成日、環境を確認
削除キーを永久に削除

​
Webhooks

​
Webhooksとは？

Webhooksは、Waffo Pancakeでイベントが発生したときにサーバーに通知します。

​
利用可能なイベント

イベントトリガー
order.completed注文完了
subscription.activatedサブスクリプション有効化
subscription.payment_succeededサブスクリプション決済成功
subscription.updatedサブスクリプション更新
subscription.cancelingサブスクリプションのキャンセル予定
subscription.canceledサブスクリプション終了
subscription.uncanceledサブスクリプションのキャンセル取り消し
subscription.past_dueサブスクリプション決済期限超過
refund.succeeded返金処理成功
refund.failed返金処理失敗

​
Webhooksのセットアップ

1

エンドポイントを追加

WebhookのURL（HTTPSが必須）を入力。
2

イベントを選択

受信したいイベントを選択。
3

設定を保存

Webhookエンドポイントを保存。

​
Webhookペイロード例

{
  "event": "order.completed",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "orderId": "660e8400-e29b-41d4-a716-446655440001",
    "amount": 2900,
    "currency": "USD",
    "status": "completed",
    "createdAt": "2026-01-15T10:30:00.000Z"
  }
}
すべてのIDはUUID v4形式です。金額は最小通貨単位です。タイムスタンプはISO 8601 UTC形式です。

​
Webhookベストプラクティス

30秒以内に2xxステータスを返す。重い処理は非同期で行う。
イベントは複数回送信される可能性があります。イベントIDで重複排除。
失敗したWebhooksは最大5回、遅延を増やしながらリトライされます（5分、30分、2時間、24時間）。
ダッシュボードでWebhook配信ログを確認。

​
APIドキュメント

​
ベースURL

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

​
アーキテクチャ

Waffo Pancake はハイブリッド API を使用します：
  • REST（POST） — /v1/actions/... 経由のすべての書き込み操作
  • GraphQL — /v1/graphql 経由のすべての読み取り操作

​
認証例

SDK を使用した API キー認証（サーバー間通信）： 
import { WaffoPancake } from "@waffo/pancake-ts";

const client = new WaffoPancake({
  merchantId: process.env.WAFFO_MERCHANT_ID!,
  privateKey: process.env.WAFFO_PRIVATE_KEY!,
});

const { store } = await client.stores.create({ name: "My Store" });

​
一般的なエンドポイント

エンドポイントメソッド説明
/v1/actions/onetime-product/create-productPOST単発プロダクトを作成
/v1/actions/subscription-product/create-productPOSTサブスクリプションプロダクトを作成
/v1/actions/onetime-order/create-orderPOSTチェックアウトセッションを作成
/v1/actions/subscription-order/create-orderPOSTサブスクリプションチェックアウトを作成
/v1/graphqlPOSTデータをクエリ (GraphQL)

完全なAPIリファレンス

リクエスト/レスポンス例を含む完全なエンドポイントドキュメント。

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

環境変数

秘密鍵はコードではなく環境変数に保存。

キーローテーション

特にチーム変更後は定期的にキーをローテーション。

キー分離

テストと本番で異なるAPIキーを使用。

安全な保管

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

​
テスト

​
テストモード

開発にはテストモードを使用：
  • すべてのエンドポイントが同じように動作
  • 実際の課金は処理されない
  • テストカード番号が利用可能
  • フルWebhookテスト

​
テストカード

カード番号動作
4242 4242 4242 4242成功
4000 0000 0000 0002拒否
4000 0000 0000 9995残高不足

​
ログとデバッグ

​
Webhookログ

Webhook配信を追跡：
  • イベントタイプ
  • 配信ステータス（成功/失敗）
  • エンドポイントからのHTTPレスポンス
  • リトライ回数とタイムスタンプ