Zum Inhalt springen
ShopentlyLearn

Datenschemas: Authentifizierung

Datenschemas: Authentifizierung. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

Abrufen · Token — Authentifizierung — Antwort

ApiResponse_TokenData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
dataTokenData Erforderlich

Beispielantwort · TokenData.

Beispiel: {"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"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich

Metadaten der Antwort.

Beispiel: {"request_id":"example"}

Zusätzliche Felder: Nein

Abrufen · Token — Authentifizierung — Antwort

TokenData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
access_tokenZeichenfolgeErforderlich

Token für den Header Authorization: Bearer. Setzen Sie vor dem separaten Beispiel SHOPENTLY_ACCESS_TOKEN.

Beispiel: "EXAMPLE_ACCESS_TOKEN"
expires_atZeichenfolgeErforderlich

Ablaufzeitpunkt in UTC. Aktuelle Zugriffsbeschränkungen können das Token bereits vorher sperren.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
expires_inGanzzahlOptional

900 Sekunden, also 15 Minuten ab Ausstellung. Anfragen verlängern die Gültigkeit nicht.

Standardwert: 900Beispiel: 900
rate_limitsTokenRateLimitsData Erforderlich

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.

Beispiel: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeZeichenfolgeOptional

Bearer. Authentifizierungsschema des zurückgegebenen Tokens.

const: "Bearer"
Standardwert: "Bearer"Beispiel: "Bearer"

Zusätzliche Felder: Nein

Anfragelimits

TokenRateLimitsData · 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. Null bedeutet nicht verfügbar, nicht unbegrenzt.
auth_per_minuteGanzzahlErforderlich

Token-Anfragen pro Minute, einschließlich fehlgeschlagener Authentifizierungsversuche.

minimum: 0maximum: 1000000
Beispiel: 10
read_per_minuteGanzzahlErforderlich

Leseanfragen pro Minute.

minimum: 0maximum: 1000000
Beispiel: 60
write_per_minuteGanzzahlErforderlich

Schreibanfragen pro Minute; dieser Wert erteilt keine Schreibrechte.

minimum: 0maximum: 1000000
Beispiel: 10

Zusätzliche Felder: Nein

Abrufen · Token — Authentifizierung — Anfrageinhalt

TokenRequest · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
ObjektZusätzliche Felder: Nein

Zusätzliche Felder: Nein