获取 · 令牌 — 身份验证
获取有效期为 900 秒的 Shopently API 令牌。查看 ApiKey 请求头、响应以及后续请求中 Bearer 的用法。
POST/api/v1/auth/token
- 身份验证
ApiKey- 最低套餐
- BASIC
- 所需权限
- 不适用
代码示例
请求示例
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request POST \
--header "Authorization: ApiKey ${SHOPENTLY_API_KEY:?}" \
--header 'Content-Type: application/json' \
--data-raw '{}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/auth/token
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_API_KEY') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = ['Content-Type: application/json'];
$headers[] = 'Authorization: ApiKey ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/auth/token');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{}');
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_API_KEY']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'ApiKey' + " " + credential
body = '{}'
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'POST', base_url + '/api/v1/auth/token', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
响应示例 200
{
"data": {
"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"
},
"meta": {
"request_id": "example"
}
}
身份验证
- API 密钥只能放在 POST /api/v1/auth/token 的 Authorization 请求头中。
- 不要将其放入 JSON、URL 或查询参数。
- 资源请求使用返回的令牌,并根据 expires_at 更新;expires_in 的单位为秒。
- 访问令牌不能绕过密钥的当前权限、商店权益、撤销状态或 IP 限制。
令牌的有效期是多久?
- expires_in: 自签发起 900 秒,即 15 分钟。发送请求不会延长有效期。
- expires_at: 以 UTC 表示的到期时间。当前的访问限制可能会提前阻止令牌访问。
对多个请求重复使用同一令牌,并在 expires_at 之前获取新令牌。无需在每次操作前获取令牌。使用 API 密钥获取新令牌。
速率限制
Engine ≥ 4.143.0. 每次令牌响应都包含签发时店铺策略中的 data.rate_limits。所有密钥共享这些额度;获取新令牌不会重置额度。套餐变更可能在令牌过期前生效。
参数
没有路径、查询或附加请求头参数。
请求体
application/json · 可选
TokenRequest
null
响应
响应 200
dataTokenData必填成功响应的数据。
字段 ·
dataaccess_token字符串必填短期 Bearer 凭据。
expires_at字符串必填凭据到期的日期和时间。
format:"date-time"expires_in整数可选凭据有效期,单位为秒。
rate_limitsTokenRateLimitsData必填每次令牌响应都包含签发时店铺策略中的 data.rate_limits。所有密钥共享这些额度;获取新令牌不会重置额度。套餐变更可能在令牌过期前生效。
字段 ·
rate_limitsauth_per_minute整数必填每分钟令牌请求数,包括失败的身份验证尝试。
minimum:0maximum:1000000read_per_minute整数必填每分钟读取请求数。
minimum:0maximum:1000000write_per_minute整数必填每分钟写入请求数;该值不授予写入权限。
minimum:0maximum:1000000
token_type字符串可选返回令牌使用的身份验证方案。
const:"Bearer"
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
字段 ·
metalocale字符串必填本次请求选择的语言。
market_code字符串必填上下文端点返回的市场代码。
market_id字符串必填上下文端点返回的市场标识符。
paginationPagination必填游标分页元数据。
request_id字符串必填申请标识符;在响应元数据中表示 HTTP 请求标识符。
minLength:1maxLength:100
locale字符串必填本次请求选择的语言。
market_code字符串必填上下文端点返回的市场代码。
market_id字符串必填上下文端点返回的市场标识符。
request_id字符串必填申请标识符;在响应元数据中表示 HTTP 请求标识符。
minLength:1maxLength:100
paginationPagination必填游标分页元数据。
request_id字符串必填申请标识符;在响应元数据中表示 HTTP 请求标识符。
minLength:1maxLength:100
HTTP 状态
200- 请求成功 架构
400- 无效请求
401- 需要身份验证
403- 权限不足
404- 未找到资源
409- 版本冲突
422- 验证失败
429- 超出请求限制
其他 HTTP 状态 (7)
405- 不允许的方法
413- 请求过大
415- 不支持的格式
500- 服务器错误
502- API 网关错误
503- 服务不可用
504- 网关超时
错误目录: ErrorResponse
请求头与响应头
401
WWW-Authenticate字符串可选服务器要求的身份验证方案。
405
Allow字符串可选此资源支持的 HTTP 方法。
429, 503
Retry-After整数可选重试前最少等待的秒数。
minimum:0.0