Ikseb · Token — Awtentikazzjoni
Ikseb token Shopently API validu għal 900 sekonda. Ara l-intestatura ApiKey, it-tweġiba u l-użu ta’ Bearer fit-talbiet li jmiss.
POST/api/v1/auth/token
- Awtentikazzjoni
ApiKey- Disponibbli minn
- BASIC
- Permessi meħtieġa
- Mhux applikabbli
Eżempji ta’ kodiċi
Eżempju ta’ talba
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))
Eżempju ta’ tweġiba 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"
}
}
Awtentikazzjoni
- Iċ-ċavetta API tintbagħat biss fil-header Authorization ta’ POST /api/v1/auth/token.
- Tpoġġihiex f’JSON, f’URL jew f’parametri tal-query.
- Uża t-token mogħti għat-talbiet tar-riżorsi u ġeddu skont expires_at; expires_in huwa espress f’sekondi.
- Token ta’ aċċess ma jevitax il-permessi attwali taċ-ċavetta, id-drittijiet tal-ħanut, ir-revoka jew ir-restrizzjonijiet IP.
Kemm idum validu token?
- expires_in: 900 sekonda, jiġifieri 15-il minuta mill-ħruġ. It-talbiet ma jestendux il-validità.
- expires_at: Il-ħin tal-iskadenza f’UTC. Ir-restrizzjonijiet attwali tal-aċċess jistgħu jimblukkaw it-token qabel.
Uża l-istess token għal diversi talbiet u ikseb ieħor qabel expires_at. Titlobx token qabel kull operazzjoni. Uża ċ-ċavetta API biex tikseb it-token il-ġdid.
Limiti tar-rata
Engine ≥ 4.143.0. Kull tweġiba tat-token tinkludi data.rate_limits mill-politika tal-ħanut fil-ħin tal-ħruġ. Iċ-ċwievet kollha jaqsmu dawn il-limiti; token ġdid ma jerġax jibdihom. Bidla fil-pjan tista’ tapplika qabel jiskadi t-token.
Parametri
M’hemmx parametri tal-mogħdija, tal-query jew ta’ headers addizzjonali.
Kontenut tat-talba
application/json · Mhux obbligatorju
TokenRequest
null
Tweġibiet
Risposta 200
Mudell sħiħ: ApiResponse_TokenData_
dataTokenDataObbligatorjuData ta’ tweġiba ta’ suċċess.
Oqsma ·
dataaccess_tokenStringObbligatorjuKredenzjal Bearer b’validità qasira.
expires_atStringObbligatorjuData u ħin tal-iskadenza tal-kredenzjal.
format:"date-time"expires_inNumru sħiħMhux obbligatorjuTul tal-validità tal-kredenzjal f’sekondi.
rate_limitsTokenRateLimitsDataObbligatorjuKull tweġiba tat-token tinkludi data.rate_limits mill-politika tal-ħanut fil-ħin tal-ħruġ. Iċ-ċwievet kollha jaqsmu dawn il-limiti; token ġdid ma jerġax jibdihom. Bidla fil-pjan tista’ tapplika qabel jiskadi t-token.
Oqsma ·
rate_limitsMudell sħiħ:
TokenRateLimitsDataauth_per_minuteNumru sħiħObbligatorjuTalbiet għal token kull minuta, inklużi tentattivi ta’ awtentikazzjoni li fallew.
minimum:0maximum:1000000read_per_minuteNumru sħiħObbligatorjuTalbiet għall-qari kull minuta.
minimum:0maximum:1000000write_per_minuteNumru sħiħObbligatorjuTalbiet għall-kitba kull minuta; dan il-valur ma jagħtix permessi għall-kitba.
minimum:0maximum:1000000
token_typeStringMhux obbligatorjuSkema tal-awtentikazzjoni għat-token mogħti.
const:"Bearer"
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorjuMetadata tat-tweġiba.
Oqsma ·
metalocaleStringObbligatorjuLingwa magħżula għal din it-talba.
market_codeStringObbligatorjuKodiċi tas-suq mogħti mill-endpoint tal-kuntest.
market_idStringObbligatorjuIdentifikatur tas-suq mogħti mill-endpoint tal-kuntest.
paginationPaginationObbligatorjuMetadata tal-paġinazzjoni bil-cursor.
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
localeStringObbligatorjuLingwa magħżula għal din it-talba.
market_codeStringObbligatorjuKodiċi tas-suq mogħti mill-endpoint tal-kuntest.
market_idStringObbligatorjuIdentifikatur tas-suq mogħti mill-endpoint tal-kuntest.
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
paginationPaginationObbligatorjuMetadata tal-paġinazzjoni bil-cursor.
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
Status HTTP
200- Risposta b’suċċess Skema
400- Talba mhux valida
401- Awtentikazzjoni meħtieġa
403- Permess miċħud
404- Riżorsa ma nstabitx
409- Kunflitt tal-verżjoni
422- Validazzjoni falliet
429- Inqabeż il-limitu tat-talbiet
Stati HTTP oħra (7)
405- Metodu mhux permess
413- Talba kbira wisq
415- Format mhux appoġġjat
500- Żball tas-server
502- Żball tal-gateway tal-API
503- Servizz mhux disponibbli
504- Skada l-ħin ta’ stennija
Katalgu tal-iżbalji: ErrorResponse
Headers
401
WWW-AuthenticateStringMhux obbligatorjuSkema ta’ awtentikazzjoni meħtieġa mis-server.
405
AllowStringMhux obbligatorjuMetodi HTTP appoġġati minn din ir-riżorsa.
429, 503
Retry-AfterNumru sħiħMhux obbligatorjuDewmien minimu qabel tentattiv ieħor, f’sekondi.
minimum:0.0