跳至内容
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 接收或返回的数据字段、类型和约束。
对象附加字段: 否

附加字段: 否