Datová schémata: Ověřování

dataTokenData Povinné

Příklad odpovědi · TokenData.

Příklad: {"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 Povinné

Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

dataTokenRevokedData Povinné

Příklad odpovědi · TokenRevokedData.

Příklad: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Povinné

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

Další pole: Ne

access_tokenŘetězecPovinné

Token pro hlavičku Authorization: Bearer. Před samostatným příkladem nastavte SHOPENTLY_ACCESS_TOKEN.

Příklad: "EXAMPLE_ACCESS_TOKEN"

expires_atŘetězecPovinné

Okamžik vypršení v UTC. Aktuální omezení přístupu mohou token zablokovat dříve.

format: "date-time"

Příklad: "2026-01-01T12:15:00Z"

expires_inCelé čísloPovinné

Skutečná platnost v sekundách; tento příklad požaduje 1800. Požadavky ji neprodlužují. expires_at je čas vypršení v UTC.

minimum: 300maximum: 3600

Příklad: 1800

permissionsPole <Řetězec> Povinné

permissions uvádí aktuální účinná oprávnění: průnik oprávnění klíče, jeho autora a tarifu obchodu včetně aktivních doplňků. Přístup se kontroluje při každém požadavku.

Příklad: ["orders.order:read"]

rate_limitsTokenRateLimitsData Povinné

Engine ≥ 4.143.0. Každá odpověď s tokenem obsahuje data.rate_limits z pravidel obchodu platných při vydání. Všechny klíče sdílejí tyto limity; nový token je neobnovuje. Změna tarifu může platit před vypršením tokenu.

Příklad: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeŘetězecVolitelné

Bearer. Způsob ověření pro vrácený token.

const: "Bearer"

Výchozí hodnota: "Bearer"Příklad: "Bearer"

warningsPole <TokenLifetimeWarning > Povinné

Celé číslo mimo rozsah nastaví 900 sekund a vrátí warnings s token.ttl_out_of_range a documentation_url na learn.shopently.com. Chybějící pole nevyvolá varování; nesprávný typ vrátí 422.

Příklad: []

Další pole: Ne

applied_secondsCelé čísloVolitelné

900 s (15 min)

Výchozí hodnota: 900

codeŘetězecVolitelné

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Výchozí hodnota: "token.ttl_out_of_range"

documentation_urlŘetězecVolitelné

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

Výchozí hodnota: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldŘetězecVolitelné

ttl_seconds

const: "ttl_seconds"

Výchozí hodnota: "ttl_seconds"

max_secondsCelé čísloVolitelné

3600 s (60 min)

Výchozí hodnota: 3600

messageŘetězecVolitelné

Celé číslo mimo rozsah nastaví 900 sekund a vrátí warnings s token.ttl_out_of_range a documentation_url na learn.shopently.com. Chybějící pole nevyvolá varování; nesprávný typ vrátí 422.

Výchozí hodnota: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsCelé čísloVolitelné

300 s (5 min)

Výchozí hodnota: 300

Další pole: Ne

auth_per_minuteCelé čísloPovinné

Požadavky na vydání a zrušení tokenu za minutu včetně neúspěšných ověření. Obě operace sdílejí limit auth.

minimum: 0maximum: 1000000

Příklad: 1

read_per_minuteCelé čísloPovinné

Požadavky na čtení za minutu.

minimum: 0maximum: 1000000

Příklad: 2

write_per_minuteCelé čísloPovinné

Požadavky na zápis za minutu; tato hodnota neuděluje právo zápisu.

minimum: 0maximum: 1000000

Příklad: 15

Další pole: Ne

ttl_secondsCelé čísloVolitelné

Volitelné celé číslo ttl_seconds: 300–3600 sekund (5–60 minut). Bez pole platí výchozích 900 sekund (15 minut).

Výchozí hodnota: 900Příklad: 1800

Další pole: Ne

access_tokenŘetězecPovinné

Pošlete POST /api/v1/auth/revoke s vydávajícím klíčem v Authorization: ApiKey a tokenem v poli JSON access_token. Po úspěchu další použití vrátí 401. Opakovaný, neznámý či cizí token vrátí stejné revoked: true; tokeny jiných klíčů se nemažou.

minLength: 1maxLength: 256

Příklad: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Další pole: Ne

revokedLogická hodnotaVolitelné

Pošlete POST /api/v1/auth/revoke s vydávajícím klíčem v Authorization: ApiKey a tokenem v poli JSON access_token. Po úspěchu další použití vrátí 401. Opakovaný, neznámý či cizí token vrátí stejné revoked: true; tokeny jiných klíčů se nemažou.

const: true

Výchozí hodnota: truePříklad: true

Další pole: Ne