Skip to main content

認証の概要

Waffo Pancake は API アクセスに 2 つの認証方式をサポートしています。

API Key 認証

API Key は RSA-SHA256 署名を使用した永続的なサーバー間認証を提供します。秘密鍵がサーバーの外に出ることはありません。

リクエストヘッダー

API Key 認証では X-Environment ヘッダーは不要です。 各 API Key は作成時に test または prod のいずれかに紐付けられます。環境は、署名の検証に成功した鍵によって自動的に決定されます。

SDK の使用(推奨)

署名アルゴリズム(手動連携)

SDK を使用しない場合は、RSA-SHA256 リクエスト署名を実装する必要があります。

手動署名の例

秘密鍵のセキュリティ
  • クライアントサイドのコードで秘密鍵を公開しないでください
  • 秘密鍵をバージョン管理にコミットしないでください
  • 秘密鍵は環境変数に保存してください
  • 特にチームメンバーの変更後は、定期的に鍵をローテーションしてください
  • タイムスタンプはサーバー時刻より 5 分以上前 であってはならず、また 1 分以上先 であってもいけません
サーバーの時刻を NTP で同期してください許容されるタイムスタンプの範囲は非対称です。サーバー時刻の 5 分前から、サーバー時刻の 1 分後までです。時計が進んでいる場合のほうが制約は厳しく、サーバーの時計が 1 分以上進んでいると、署名自体が正しくても、署名付きリクエストはすべて 401 Unauthorized で拒否されます。

Store Slug 認証

公開チェックアウトフローでは、Store Slug 認証を使用します。これにより、訪問者は API Key 認証情報なしでチェックアウトセッションの作成や公開ストアデータのクエリが可能になります。

リクエストヘッダー

使用例


API Key の作成

1

API と開発ページに移動

ダッシュボード → API と開発 → API Keys に移動します
2

API Key を作成

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

名前と設定

分かりやすい名前(例:「Production Server」)を付け、対象環境(Test または Production)を選択します。
4

秘密鍵をダウンロード

秘密鍵をすぐにダウンロードしてください。 再度表示されることはありません。
API Key の削除は即座に実行され、取り消しできません。削除された鍵で署名されたリクエストは 401 Unauthorized で失敗します。

認証方式の比較


認証エラー


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

  1. クライアントサイドのコード、バージョン管理、公開リポジトリで秘密鍵を公開しないでください
  2. すべての API リクエストに HTTPS を使用してください
  3. 偽造リクエストを防ぐために Webhook 署名を検証してください
  4. テストと本番の鍵を分離してください — 環境ごとに異なる鍵を作成してください
  5. 特にチームメンバーの変更後は、定期的に鍵をローテーションしてください
  6. ダッシュボードで API 使用状況を監視し、異常な活動がないか確認してください