Получаване · Токен — Удостоверяване
Получете токен за Shopently API, валиден 900 секунди. Вижте заглавката 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 ключът се изпраща единствено в заглавката Authorization на POST /api/v1/auth/token.
- Не го поставяйте в 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
Пълен модел: ApiResponse_TokenData_
dataTokenDataЗадължителноДанни на успешния отговор.
Полета ·
dataaccess_tokenНизЗадължителноКраткотрайни данни за достъп Bearer.
expires_atНизЗадължителноДата и час на изтичане на данните за достъп.
format:"date-time"expires_inЦяло числоНезадължителноВалидност на данните за достъп в секунди.
rate_limitsTokenRateLimitsDataЗадължителноВсеки отговор с токен съдържа data.rate_limits от политиката на магазина при издаването. Всички ключове споделят тези лимити; нов токен не ги нулира. Промяна на плана може да важи преди изтичането на токена.
Полета ·
rate_limitsПълен модел:
TokenRateLimitsDataauth_per_minuteЦяло числоЗадължителноЗаявки за токен в минута, включително неуспешните опити за удостоверяване.
minimum:0maximum:1000000read_per_minuteЦяло числоЗадължителноЗаявки за четене в минута.
minimum:0maximum:1000000write_per_minuteЦяло числоЗадължителноЗаявки за запис в минута; тази стойност не дава права за запис.
minimum:0maximum:1000000
token_typeНизНезадължителноСхема за удостоверяване на върнатия токен.
const:"Bearer"
metaContextPageMetaContextMetaPageMetaRequestMetaЗадължителноМетаданни на отговора.
Полета ·
metalocaleНизЗадължителноЕзик, избран за тази заявка.
market_codeНизЗадължителноКод на пазара, върнат от endpoint за контекст.
market_idНизЗадължителноИдентификатор на пазара, върнат от endpoint за контекст.
paginationPaginationЗадължителноМетаданни за страниране с cursor.
request_idНизЗадължителноИдентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.
minLength:1maxLength:100
localeНизЗадължителноЕзик, избран за тази заявка.
market_codeНизЗадължителноКод на пазара, върнат от endpoint за контекст.
market_idНизЗадължителноИдентификатор на пазара, върнат от endpoint за контекст.
request_idНизЗадължителноИдентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.
minLength:1maxLength:100
paginationPaginationЗадължителноМетаданни за страниране с cursor.
request_idНизЗадължителноИдентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.
minLength:1maxLength:100
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