跳至內容
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。所有金鑰共用這些額度;取得新權杖不會重設額度。方案變更可能在權杖到期前生效。 零表示無法使用,而不是無限制。
auth_per_minute整數必填

每分鐘權杖請求數,包含失敗的身分驗證嘗試。

minimum: 0maximum: 1000000
示例: 10
read_per_minute整數必填

每分鐘讀取請求數。

minimum: 0maximum: 1000000
示例: 60
write_per_minute整數必填

每分鐘寫入請求數;此值不授予寫入權限。

minimum: 0maximum: 1000000
示例: 10

附加欄位: 否

取得 · 權杖 — 身份驗證 — 請求本文

TokenRequest · API 接收或傳回的資料欄位、類型和限制。
物件附加欄位: 否

附加欄位: 否