データスキーマ: 認証

dataTokenData 必須

レスポンス例 · TokenData.

例: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:15:00Z","expires_in":1800,"permissions":["orders.order:read"],"rate_limits":{"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15},"token_type":"Bearer","warnings":[]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

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

例: {"request_id":"example"}

追加フィールド: いいえ

dataTokenRevokedData 必須

レスポンス例 · TokenRevokedData.

例: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

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

例: {"request_id":"example-request"}

追加フィールド: いいえ

access_token文字列必須

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

例: "EXAMPLE_ACCESS_TOKEN"

expires_at文字列必須

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

format: "date-time"

例: "2026-01-01T12:15:00Z"

expires_in整数必須

実際の有効期間（秒）です。この例では1800を指定します。リクエストで延長されません。expires_at はUTCの有効期限です。

minimum: 300maximum: 3600

例: 1800

permissions配列 <文字列> 必須

permissions は現在有効な権限です。キー、作成者、ストアプランの権限の共通部分で、有効なアドオン権限も含みます。アクセス権はリクエストごとに再確認されます。

例: ["orders.order:read"]

rate_limitsTokenRateLimitsData 必須

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

例: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_type文字列任意

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

const: "Bearer"

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

warnings配列 <TokenLifetimeWarning > 必須

範囲外の整数は900秒となり、warnings に token.ttl_out_of_range と learn.shopently.com への documentation_url を返します。省略時は警告なし、不正な型は422です。

例: []

追加フィールド: いいえ

applied_seconds整数任意

900 s (15 min)

既定値: 900

code文字列任意

token.ttl_out_of_range

const: "token.ttl_out_of_range"

既定値: "token.ttl_out_of_range"

documentation_url文字列任意

https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

既定値: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

field文字列任意

ttl_seconds

const: "ttl_seconds"

既定値: "ttl_seconds"

max_seconds整数任意

3600 s (60 min)

既定値: 3600

message文字列任意

範囲外の整数は900秒となり、warnings に token.ttl_out_of_range と learn.shopently.com への documentation_url を返します。省略時は警告なし、不正な型は422です。

既定値: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_seconds整数任意

300 s (5 min)

既定値: 300

追加フィールド: いいえ

auth_per_minute整数必須

認証失敗を含む、1分あたりのトークン発行・取り消しリクエスト数です。両操作で auth の上限を共有します。

minimum: 0maximum: 1000000

例: 1

read_per_minute整数必須

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

minimum: 0maximum: 1000000

例: 2

write_per_minute整数必須

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

minimum: 0maximum: 1000000

例: 15

追加フィールド: いいえ

ttl_seconds整数任意

任意の整数 ttl_seconds：300～3600秒（5～60分）。省略時の既定値は900秒（15分）です。

既定値: 900例: 1800

追加フィールド: いいえ

access_token文字列必須

POST /api/v1/auth/revoke に、発行元のキーを Authorization: ApiKey、トークンをJSONの access_token として送信します。成功後の利用は401になります。繰り返し、不明、他のキーのトークンでも同じ revoked: true を返し、他のキーのトークンは削除しません。

minLength: 1maxLength: 256

例: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

追加フィールド: いいえ

revoked真偽値任意

POST /api/v1/auth/revoke に、発行元のキーを Authorization: ApiKey、トークンをJSONの access_token として送信します。成功後の利用は401になります。繰り返し、不明、他のキーのトークンでも同じ revoked: true を返し、他のキーのトークンは削除しません。

const: true

既定値: true例: true

追加フィールド: いいえ