Abrufen · Token — Authentifizierung
Fordern Sie ein 900 Sekunden gültiges Shopently-API-Token an. Erfahren Sie mehr über ApiKey-Header, Antwort und Bearer für weitere Anfragen.
POST/api/v1/auth/token
- Authentifizierung
ApiKey- Verfügbar ab
- BASIC
- Erforderliche Berechtigungen
- Nicht zutreffend
Codebeispiele
Beispielanfrage
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))
Beispielantwort 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"
}
}
Authentifizierung
- Der API-Schlüssel wird ausschließlich im Authorization-Header von POST /api/v1/auth/token übermittelt.
- Er gehört weder in JSON noch in URLs oder Abfrageparameter.
- Verwenden Sie den zurückgegebenen Token für Ressourcenanfragen und erneuern Sie ihn anhand von expires_at; expires_in wird in Sekunden angegeben.
- Ein Zugriffstoken umgeht keine aktuellen Schlüsselrechte, Tarifberechtigungen, Widerrufe oder IP-Beschränkungen.
Wie lange gilt ein Token?
- expires_in: 900 Sekunden, also 15 Minuten ab Ausstellung. Anfragen verlängern die Gültigkeit nicht.
- expires_at: Ablaufzeitpunkt in UTC. Aktuelle Zugriffsbeschränkungen können das Token bereits vorher sperren.
Verwenden Sie das Token für mehrere Anfragen und fordern Sie vor expires_at ein neues an. Ein neues Token ist nicht vor jeder Operation nötig. Verwenden Sie dafür Ihren API-Schlüssel.
Anfragelimits
Engine ≥ 4.143.0. Jede Token-Antwort enthält data.rate_limits aus der bei Ausstellung geltenden Shop-Richtlinie. Alle Schlüssel teilen diese Budgets; ein neues Token setzt sie nicht zurück. Tarifänderungen können vor Ablauf des Tokens gelten.
Parameter
Keine Pfad-, Abfrage- oder zusätzlichen Header-Parameter.
Anfrageinhalt
application/json · Optional
TokenRequest
null
Antworten
Antwort 200
Vollständiges Modell: ApiResponse_TokenData_
dataTokenDataErforderlichNutzdaten einer erfolgreichen Antwort.
Felder ·
dataVollständiges Modell:
TokenDataaccess_tokenZeichenfolgeErforderlichKurzlebiger Bearer-Zugriffstoken.
expires_atZeichenfolgeErforderlichAblaufdatum und Ablaufzeit des Tokens.
format:"date-time"expires_inGanzzahlOptionalGültigkeitsdauer des Tokens in Sekunden.
rate_limitsTokenRateLimitsDataErforderlichJede Token-Antwort enthält data.rate_limits aus der bei Ausstellung geltenden Shop-Richtlinie. Alle Schlüssel teilen diese Budgets; ein neues Token setzt sie nicht zurück. Tarifänderungen können vor Ablauf des Tokens gelten.
Felder ·
rate_limitsVollständiges Modell:
TokenRateLimitsDataauth_per_minuteGanzzahlErforderlichToken-Anfragen pro Minute, einschließlich fehlgeschlagener Authentifizierungsversuche.
minimum:0maximum:1000000read_per_minuteGanzzahlErforderlichLeseanfragen pro Minute.
minimum:0maximum:1000000write_per_minuteGanzzahlErforderlichSchreibanfragen pro Minute; dieser Wert erteilt keine Schreibrechte.
minimum:0maximum:1000000
token_typeZeichenfolgeOptionalAuthentifizierungsschema des zurückgegebenen Tokens.
const:"Bearer"
metaContextPageMetaContextMetaPageMetaRequestMetaErforderlichMetadaten der Antwort.
Felder ·
metaVollständiges Modell:
ContextPageMetalocaleZeichenfolgeErforderlichFür diese Anfrage ausgewählte Sprache.
market_codeZeichenfolgeErforderlichVom Kontext-Endpunkt zurückgegebener Marktcode.
market_idZeichenfolgeErforderlichVom Kontext-Endpunkt zurückgegebene Marktkennung.
paginationPaginationErforderlichMetadaten der Cursor-Paginierung.
request_idZeichenfolgeErforderlichVorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength:1maxLength:100
Vollständiges Modell:
ContextMetalocaleZeichenfolgeErforderlichFür diese Anfrage ausgewählte Sprache.
market_codeZeichenfolgeErforderlichVom Kontext-Endpunkt zurückgegebener Marktcode.
market_idZeichenfolgeErforderlichVom Kontext-Endpunkt zurückgegebene Marktkennung.
request_idZeichenfolgeErforderlichVorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength:1maxLength:100
Vollständiges Modell:
PageMetapaginationPaginationErforderlichMetadaten der Cursor-Paginierung.
request_idZeichenfolgeErforderlichVorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength:1maxLength:100
Vollständiges Modell:
RequestMetarequest_idZeichenfolgeErforderlichVorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength:1maxLength:100
HTTP-Status
200- Erfolgreiche Antwort Schema
400- Ungültige Anfrage
401- Authentifizierung erforderlich
403- Berechtigung verweigert
404- Ressource nicht gefunden
409- Versionskonflikt
422- Validierung fehlgeschlagen
429- Anfragelimit überschritten
Weitere HTTP-Statuscodes (7)
405- Methode nicht erlaubt
413- Anfrage zu groß
415- Nicht unterstützter Medientyp
500- Serverfehler
502- API-Gateway-Fehler
503- Dienst nicht verfügbar
504- Gateway-Zeitüberschreitung
Fehlerkatalog: ErrorResponse
Header
401
WWW-AuthenticateZeichenfolgeOptionalVom Server verlangtes Authentifizierungsschema.
405
AllowZeichenfolgeOptionalVon dieser Ressource unterstützte HTTP-Methoden.
429, 503
Retry-AfterGanzzahlOptionalMindestwartezeit vor einem erneuten Versuch in Sekunden.
minimum:0.0