コンテンツにスキップ
ShopentlyLearn

データスキーマ: 認証

データスキーマ: 認証. API が受け取る、または返すデータのフィールド、型、制約。

データスキーマ

取得 · トークン — 認証 — レスポンス

ApiResponse_TokenData_ · API が受け取る、または返すデータのフィールド、型、制約。
dataTokenData 必須

レスポンス例 · TokenData.

例: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example"}

追加フィールド: いいえ

取得 · トークン — 認証 — レスポンス

TokenData · API が受け取る、または返すデータのフィールド、型、制約。
access_token文字列必須

Authorization: Bearerヘッダーに指定するトークンです。別のサンプルを実行する前にSHOPENTLY_ACCESS_TOKENに設定してください。

例: "EXAMPLE_ACCESS_TOKEN"
expires_at文字列必須

UTCで表される有効期限です。現在のアクセス制限によって、それより前に利用が拒否される場合があります。

format: "date-time"
例: "2026-01-01T12:00:00Z"
expires_in整数任意

発行から900秒、つまり15分です。リクエストを送信しても有効期間は延長されません。

既定値: 900例: 900
rate_limitsTokenRateLimitsData 必須

Engine ≥ 4.143.0. トークンの各応答には、発行時の店舗ポリシーに基づく data.rate_limits が含まれます。すべてのキーで上限を共有し、新しいトークンでもリセットされません。プラン変更はトークンの有効期限前に適用される場合があります。

例: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_type文字列任意

Bearer. 返されたトークンの認証方式。

const: "Bearer"
既定値: "Bearer"例: "Bearer"

追加フィールド: いいえ

レート制限

TokenRateLimitsData · Engine ≥ 4.143.0. トークンの各応答には、発行時の店舗ポリシーに基づく data.rate_limits が含まれます。すべてのキーで上限を共有し、新しいトークンでもリセットされません。プラン変更はトークンの有効期限前に適用される場合があります。 0 は無制限ではなく、利用できないことを示します。
auth_per_minute整数必須

認証失敗を含む、1分あたりのトークンリクエスト数。

minimum: 0maximum: 1000000
例: 10
read_per_minute整数必須

1分あたりの読み取りリクエスト数。

minimum: 0maximum: 1000000
例: 60
write_per_minute整数必須

1分あたりの書き込みリクエスト数。この値は書き込み権限を付与しません。

minimum: 0maximum: 1000000
例: 10

追加フィールド: いいえ

取得 · トークン — 認証 — リクエスト本文

TokenRequest · API が受け取る、または返すデータのフィールド、型、制約。
オブジェクト追加フィールド: いいえ

追加フィールド: いいえ