Get an access token
Obtain a Shopently API token valid for 900 seconds. Check the ApiKey header, response and Bearer usage for subsequent requests.
POST/api/v1/auth/token
- Authentication
ApiKey- Available from
- BASIC
- Required permissions
- Not applicable
Code examples
Request example
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))
Response example 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"
}
}
Authentication
- The API key is sent exclusively in the Authorization header of POST /api/v1/auth/token.
- Do not put it in JSON, a URL or query parameters.
- Use the returned token for resource requests and renew it according to expires_at; expires_in is expressed in seconds.
- An access token does not bypass current key permissions, store entitlements, revocation or IP restrictions.
How long does a token last?
- expires_in: 900 seconds, or 15 minutes from issuance. Making requests does not extend its lifetime.
- expires_at: Expiration time in UTC. Current access restrictions can block the token earlier.
Reuse the same token for multiple requests and obtain another before expires_at. Do not request a token before every operation. Use your API key to obtain the new token.
Rate limits
Engine ≥ 4.143.0. Each token response includes data.rate_limits from the store policy at issuance. All keys share these budgets; a new token does not reset them. A plan change may apply before the token expires.
Parameters
No path, query or additional header parameters.
Request body
application/json · Optional
TokenRequest
null
Responses
Response 200
Full model: ApiResponse_TokenData_
dataTokenDataRequiredSuccessful response payload.
Fields ·
dataaccess_tokenStringRequiredShort-lived Bearer credential.
expires_atStringRequiredCredential expiration date and time.
format:"date-time"expires_inIntegerOptionalCredential lifetime in seconds.
rate_limitsTokenRateLimitsDataRequiredEach token response includes data.rate_limits from the store policy at issuance. All keys share these budgets; a new token does not reset them. A plan change may apply before the token expires.
Fields ·
rate_limitsFull model:
TokenRateLimitsDataauth_per_minuteIntegerRequiredToken requests per minute, including failed authentication attempts.
minimum:0maximum:1000000read_per_minuteIntegerRequiredRead requests per minute.
minimum:0maximum:1000000write_per_minuteIntegerRequiredWrite requests per minute; this value does not grant write permissions.
minimum:0maximum:1000000
token_typeStringOptionalAuthentication scheme for the returned token.
const:"Bearer"
metaContextPageMetaContextMetaPageMetaRequestMetaRequiredResponse metadata.
Fields ·
metalocaleStringRequiredLanguage selected for this request.
market_codeStringRequiredMarket code returned by the context endpoint.
market_idStringRequiredMarket identifier returned by the context endpoint.
paginationPaginationRequiredCursor pagination metadata.
request_idStringRequiredRequest identifier; in response metadata this identifies the HTTP request.
minLength:1maxLength:100
localeStringRequiredLanguage selected for this request.
market_codeStringRequiredMarket code returned by the context endpoint.
market_idStringRequiredMarket identifier returned by the context endpoint.
request_idStringRequiredRequest identifier; in response metadata this identifies the HTTP request.
minLength:1maxLength:100
paginationPaginationRequiredCursor pagination metadata.
request_idStringRequiredRequest identifier; in response metadata this identifies the HTTP request.
minLength:1maxLength:100
request_idStringRequiredRequest identifier; in response metadata this identifies the HTTP request.
minLength:1maxLength:100
HTTP status
200- Successful response Schema
400- Invalid request
401- Authentication required
403- Permission denied
404- Resource not found
409- Version conflict
422- Validation failed
429- Rate limit exceeded
Other HTTP statuses (7)
405- Method not allowed
413- Request too large
415- Unsupported media type
500- Server error
502- API gateway error
503- Service unavailable
504- Gateway timeout
Error catalog: ErrorResponse
Headers
401
WWW-AuthenticateStringOptionalAuthentication scheme required by the server.
405
AllowStringOptionalHTTP methods supported by this resource.
429, 503
Retry-AfterIntegerOptionalMinimum delay before retrying, in seconds.
minimum:0.0