Datenschemas: Authentifizierung

dataTokenData Erforderlich

Beispielantwort · TokenData.

Beispiel: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:15:00Z","expires_in":1800,"permissions":["orders.order:read"],"rate_limits":{"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15},"token_type":"Bearer","warnings":[]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Erforderlich

Metadaten der Antwort.

Beispiel: {"request_id":"example"}

Zusätzliche Felder: Nein

dataTokenRevokedData Erforderlich

Beispielantwort · TokenRevokedData.

Beispiel: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Erforderlich

Metadaten der Antwort.

Beispiel: {"request_id":"example-request"}

Zusätzliche Felder: Nein

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:15:00Z"

expires_inGanzzahlErforderlich

Tatsächliche Gültigkeitsdauer in Sekunden; dieses Beispiel fordert 1800 an. Anfragen verlängern sie nicht. expires_at ist der Ablaufzeitpunkt in UTC.

minimum: 300maximum: 3600

Beispiel: 1800

permissionsArray <Zeichenfolge> Erforderlich

permissions enthält die aktuell wirksamen Rechte: die Schnittmenge aus Schlüsselrechten, Autorenrechten und Shop-Tarif einschließlich aktiver Addon-Rechte. Jede Anfrage prüft den Zugriff erneut.

Beispiel: ["orders.order:read"]

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":1,"read_per_minute":2,"write_per_minute":15}

token_typeZeichenfolgeOptional

Bearer. Authentifizierungsschema des zurückgegebenen Tokens.

const: "Bearer"

Standardwert: "Bearer"Beispiel: "Bearer"

warningsArray <TokenLifetimeWarning > Erforderlich

Eine Ganzzahl außerhalb des Bereichs setzt 900 Sekunden und liefert warnings mit token.ttl_out_of_range und documentation_url auf learn.shopently.com. Ein fehlendes Feld erzeugt keine Warnung; ungültige Typen führen zu 422.

Beispiel: []

Zusätzliche Felder: Nein

applied_secondsGanzzahlOptional

900 s (15 min)

Standardwert: 900

codeZeichenfolgeOptional

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Standardwert: "token.ttl_out_of_range"

documentation_urlZeichenfolgeOptional

https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

Standardwert: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldZeichenfolgeOptional

ttl_seconds

const: "ttl_seconds"

Standardwert: "ttl_seconds"

max_secondsGanzzahlOptional

3600 s (60 min)

Standardwert: 3600

messageZeichenfolgeOptional

Eine Ganzzahl außerhalb des Bereichs setzt 900 Sekunden und liefert warnings mit token.ttl_out_of_range und documentation_url auf learn.shopently.com. Ein fehlendes Feld erzeugt keine Warnung; ungültige Typen führen zu 422.

Standardwert: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsGanzzahlOptional

300 s (5 min)

Standardwert: 300

Zusätzliche Felder: Nein

auth_per_minuteGanzzahlErforderlich

Anfragen zur Token-Ausstellung und zum Widerruf pro Minute, einschließlich fehlgeschlagener Authentifizierungen. Beide nutzen dasselbe auth-Budget.

minimum: 0maximum: 1000000

Beispiel: 1

read_per_minuteGanzzahlErforderlich

Leseanfragen pro Minute.

minimum: 0maximum: 1000000

Beispiel: 2

write_per_minuteGanzzahlErforderlich

Schreibanfragen pro Minute; dieser Wert erteilt keine Schreibrechte.

minimum: 0maximum: 1000000

Beispiel: 15

Zusätzliche Felder: Nein

ttl_secondsGanzzahlOptional

Optionale Ganzzahl ttl_seconds: 300–3600 Sekunden (5–60 Minuten). Ohne Feld gelten standardmäßig 900 Sekunden (15 Minuten).

Standardwert: 900Beispiel: 1800

Zusätzliche Felder: Nein

access_tokenZeichenfolgeErforderlich

Sende POST /api/v1/auth/revoke mit dem ausstellenden Schlüssel in Authorization: ApiKey und dem Token im JSON-Feld access_token. Danach liefern weitere Zugriffe 401. Wiederholte, unbekannte oder fremde Tokens erhalten dasselbe revoked: true; Tokens anderer Schlüssel werden nie gelöscht.

minLength: 1maxLength: 256

Beispiel: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Zusätzliche Felder: Nein

revokedBoolescher WertOptional

Sende POST /api/v1/auth/revoke mit dem ausstellenden Schlüssel in Authorization: ApiKey und dem Token im JSON-Feld access_token. Danach liefern weitere Zugriffe 401. Wiederholte, unbekannte oder fremde Tokens erhalten dasselbe revoked: true; Tokens anderer Schlüssel werden nie gelöscht.

const: true

Standardwert: trueBeispiel: true

Zusätzliche Felder: Nein