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

​
認証の概要

Waffo Pancake は、API アクセスに2つの認証方式をサポートしています：
方式使用シナリオ説明
API Keyサーバー間通信Merchant ID と秘密鍵を使用した永続的な認証
Store Slug公開チェックアウトフローX-Store-Slug と X-Environment ヘッダーによる公開アクセス

​
API Key 認証

API Key は永続的なサーバー間認証を提供します。秘密鍵はサーバーから出ることはありません。
API Key 認証は SDK が自動的に処理します。@waffo/pancake-ts をインストールし、Merchant ID と秘密鍵を提供するだけで、SDK がリクエストの署名を自動的に行います。

​
SDK の使用（推奨）

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" });
API Key 認証は X-Environment ヘッダーを必要としません。環境はキー登録時に選択した環境（test または prod）で決定されます。

​
API Key の作成

1

開発者ページに移動

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

API キーを作成

「API キーを作成」をクリックして新しいキーペアを生成。公開鍵は自動的にサーバーに送信されます。
3

名前と設定

わかりやすい名前（例：「本番サーバー」）を付け、ターゲット環境（テストまたは本番）を選択。
4

秘密鍵をダウンロード

秘密鍵を直ちにダウンロード。二度と表示されません。
API Key の削除は即座かつ不可逆です。削除されたキーを使用したリクエストは 401 Unauthorized で失敗します。

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

  • 秘密鍵を公開しない — クライアントサイドコード、バージョン管理、公開リポジトリに含めない
  • 環境変数を使用 してサーバーアプリケーションにキーを保存
  • テストと本番のキーを分離 — 各環境に別々のキーを作成
  • 定期的にキーをローテーション、特にチームメンバーの変更後
  • API 使用状況を監視 ダッシュボードで異常なアクティビティを確認
# キーを環境変数として保存
export WAFFO_PRIVATE_KEY="your-private-key-content"
export WAFFO_MERCHANT_ID="your-merchant-uuid"

​
認証エラー

ステータスメッセージ解決策
401API Key が無効Merchant ID と秘密鍵が正しいか確認
401認証情報が不足SDK が有効な認証情報で初期化されているか確認
403権限が不十分必要な権限を持つキーを使用