Отримати · Токен — Автентифікація
Отримайте токен 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РядокОбов’язковеКод ринку, повернутий кінцевою точкою контексту.
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
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