消費者がストアで注文を作成するためのセッショントークンを発行します。これは API Key 専用エンドポイントです。
POST /v1/actions/auth/issue-session-token
認証: API Key
セッションタイプ
| タイプ | TTL | 動作 | 説明 |
|---|
customer | 5分 | 各 API コールで自動更新 | マーチャント発行、単一ストアスコープ、注文作成可能 |
consumer | 30分 | 各 API コールで自動更新 | ユーザー開始ログイン、クロスストアスコープ |
shopper | 1分 | 使い切り、最初の API コール後に削除 | マーチャント発行、ワンタイムチェックアウトのみ |
現在のバージョンでは常に customer ロールのトークンを発行します。上記の表はすべてのサポートされるセッションタイプの参考情報です。
Shopper セッションは使い切りトークンです。 最初の API コール(例:create-order)でセッションが消費されます。同じトークンでの後続のリクエストは認証エラーを返します。
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|
storeId | string | はい | 対象ストア ID(Short ID 形式 STO_xxx) |
buyerIdentity | string | はい | 消費者の識別情報(例:メールアドレス) |
リクエスト例
const { token, expiresAt } = await client.auth.issueSessionToken({
storeId: "STO_2aUyqjCzEIiEcYMKj7TZtw",
buyerIdentity: "customer@example.com",
});
成功レスポンス(200)
{
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiresAt": "2024-01-15T11:00:00.000Z"
}
}
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|
token | string | セッショントークン |
expiresAt | string | 有効期限(ISO 8601) |
エラーレスポンス
| ステータス | エラー | 説明 |
|---|
| 400 | Missing required field: storeId | storeId が指定されていません |
| 400 | Missing required field: buyerIdentity | buyerIdentity が指定されていません |
| 400 | Store is not active | ストアが無効または停止中です |
| 403 | Access denied: you do not have permission to this store | マーチャントがこのストアを所有していません |
| 404 | Store not found | ストア ID が存在しません |