取得 · 權杖 — 身份驗證
取得有效期限為 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