Hoppa till innehållet
ShopentlyLearn

Hämta · Token — Autentisering

Hämta en Shopently API-token som gäller i 900 sekunder. Läs om ApiKey-headern, svaret och Bearer för efterföljande anrop.

POST/api/v1/auth/token

Autentisering
ApiKey
Tillgänglig från
BASIC
Behörigheter som krävs
Ej tillämpligt

Kodexempel

Exempel på begäran

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))

Exempel på svar 200

JSON
{
  "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"
  }
}

Autentisering

  • API-nyckeln skickas endast i HTTP-huvudet Authorization för POST /api/v1/auth/token.
  • Lägg den inte i JSON, en URL eller frågeparametrar.
  • Använd den returnerade token för resursbegäranden och förnya den enligt expires_at.
  • expires_in anges i sekunder.
  • En åtkomsttoken kringgår inte nyckelns aktuella behörigheter, butikens abonnemangsvillkor, återkallelser eller IP-begränsningar.

Hur länge är en token giltig?

  • expires_in: 900 sekunder, alltså 15 minuter från utfärdandet. Anrop förlänger inte giltighetstiden.
  • expires_at: Utgångstid i UTC. Aktuella åtkomstbegränsningar kan blockera token tidigare.

Återanvänd samma token för flera anrop och hämta en ny före expires_at. Hämta inte en token inför varje åtgärd. Använd API-nyckeln för att hämta den nya token.

Anropsgränser

Engine ≥ 4.143.0. Varje tokensvar innehåller data.rate_limits från butikens policy vid utfärdandet. Alla nycklar delar dessa budgetar; en ny token återställer dem inte. En planändring kan gälla innan token löper ut.

Parametrar

Inga parametrar för sökväg, frågesträng eller ytterligare HTTP-huvuden.

Begärans innehåll

application/json · Valfritt

TokenRequest null

Svar

Svar 200

dataTokenData Obligatoriskt

Innehållet i ett lyckat svar.

Fält · data
access_tokenSträngObligatoriskt

Kortlivad Bearer-token.

expires_atSträngObligatoriskt

Datum och tid när autentiseringsuppgiften upphör att gälla.

format: "date-time"
expires_inHeltalValfritt

Autentiseringsuppgiftens giltighetstid i sekunder.

Standardvärde: 900

rate_limitsTokenRateLimitsData Obligatoriskt

Varje tokensvar innehåller data.rate_limits från butikens policy vid utfärdandet. Alla nycklar delar dessa budgetar; en ny token återställer dem inte. En planändring kan gälla innan token löper ut.

Fält · rate_limits
auth_per_minuteHeltalObligatoriskt

Tokenanrop per minut, inklusive misslyckade autentiseringsförsök.

minimum: 0maximum: 1000000
read_per_minuteHeltalObligatoriskt

Läsanrop per minut.

minimum: 0maximum: 1000000
write_per_minuteHeltalObligatoriskt

Skrivanrop per minut; värdet ger inte skrivbehörighet.

minimum: 0maximum: 1000000
token_typeSträngValfritt

Autentiseringsschema för den returnerade token.

const: "Bearer"

Standardvärde: "Bearer"

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt

Metadata för svaret.

Fält · meta

ContextPageMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

ContextMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

RequestMeta

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel på svar

HTTP-status

200
Lyckat svar Schema
400
Ogiltig begäran
401
Autentisering krävs
403
Åtkomst nekad
404
Resursen hittades inte
409
Versionskonflikt
422
Valideringen misslyckades
429
Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405
Metoden tillåts inte
413
För stor begäran
415
Formatet stöds inte
500
Serverfel
502
Fel i API-gateway
503
Tjänsten är inte tillgänglig
504
Tidsgränsen överskreds

Felkatalog: ErrorResponse

HTTP-huvuden

401

WWW-AuthenticateSträngValfritt

Autentiseringsschema som servern kräver.

405

AllowSträngValfritt

HTTP-metoder som resursen stöder.

429, 503

Retry-AfterHeltalValfritt

Minsta väntetid före ett nytt försök, i sekunder.

minimum: 0.0