Dataskemaer: Godkendelse

dataTokenData Obligatorisk

Eksempel på svar · TokenData.

Eksempel: {"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 Obligatorisk

Svarmetadata.

Eksempel: {"request_id":"example"}

Yderligere felter: Nej

dataTokenRevokedData Obligatorisk

Eksempel på svar · TokenRevokedData.

Eksempel: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

access_tokenStrengObligatorisk

Token til headeren Authorization: Bearer. Indstil SHOPENTLY_ACCESS_TOKEN, før du kører det separate eksempel.

Eksempel: "EXAMPLE_ACCESS_TOKEN"

expires_atStrengObligatorisk

Udløbstidspunkt i UTC. Aktuelle adgangsbegrænsninger kan blokere tokenet tidligere.

format: "date-time"

Eksempel: "2026-01-01T12:15:00Z"

expires_inHeltalObligatorisk

Faktisk gyldighed i sekunder; dette eksempel beder om 1800. Anmodninger forlænger den ikke. expires_at er udløbstidspunktet i UTC.

minimum: 300maximum: 3600

Eksempel: 1800

permissionsArray <Streng> Obligatorisk

permissions viser de aktuelle effektive rettigheder: fællesmængden af nøglens, forfatterens og butikkens abonnementsrettigheder, inklusive aktive tilføjelser. Adgang kontrolleres ved hver anmodning.

Eksempel: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obligatorisk

Engine ≥ 4.143.0. Hvert tokensvar indeholder data.rate_limits fra butikkens politik ved udstedelsen. Alle nøgler deler disse budgetter; en ny token nulstiller dem ikke. En abonnementsændring kan gælde, før tokenen udløber.

Eksempel: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeStrengValgfrit

Bearer. Godkendelsesmetode for det returnerede token.

const: "Bearer"

Standard: "Bearer"Eksempel: "Bearer"

warningsArray <TokenLifetimeWarning > Obligatorisk

Et heltal uden for intervallet anvender 900 sekunder og returnerer warnings med token.ttl_out_of_range og documentation_url til learn.shopently.com. Et manglende felt giver ingen advarsel; forkert type giver 422.

Eksempel: []

Yderligere felter: Nej

applied_secondsHeltalValgfrit

900 s (15 min)

Standard: 900

codeStrengValgfrit

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Standard: "token.ttl_out_of_range"

documentation_urlStrengValgfrit

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

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

fieldStrengValgfrit

ttl_seconds

const: "ttl_seconds"

Standard: "ttl_seconds"

max_secondsHeltalValgfrit

3600 s (60 min)

Standard: 3600

messageStrengValgfrit

Et heltal uden for intervallet anvender 900 sekunder og returnerer warnings med token.ttl_out_of_range og documentation_url til learn.shopently.com. Et manglende felt giver ingen advarsel; forkert type giver 422.

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

min_secondsHeltalValgfrit

300 s (5 min)

Standard: 300

Yderligere felter: Nej

auth_per_minuteHeltalObligatorisk

Anmodninger om udstedelse og tilbagekaldelse pr. minut, inklusive mislykket godkendelse. Begge operationer deler auth-grænsen.

minimum: 0maximum: 1000000

Eksempel: 1

read_per_minuteHeltalObligatorisk

Læseanmodninger pr. minut.

minimum: 0maximum: 1000000

Eksempel: 2

write_per_minuteHeltalObligatorisk

Skriveanmodninger pr. minut; værdien giver ikke skriverettigheder.

minimum: 0maximum: 1000000

Eksempel: 15

Yderligere felter: Nej

ttl_secondsHeltalValgfrit

Valgfrit heltal ttl_seconds: 300–3600 sekunder (5–60 minutter). Uden feltet er standarden 900 sekunder (15 minutter).

Standard: 900Eksempel: 1800

Yderligere felter: Nej

access_tokenStrengObligatorisk

Send POST /api/v1/auth/revoke med den udstedende nøgle i Authorization: ApiKey og tokenet i JSON-feltet access_token. Efter succes giver næste brug 401. Gentagne, ukendte eller fremmede tokens får samme revoked: true; andre nøglers tokens slettes aldrig.

minLength: 1maxLength: 256

Eksempel: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Yderligere felter: Nej

revokedBoolesk værdiValgfrit

Send POST /api/v1/auth/revoke med den udstedende nøgle i Authorization: ApiKey og tokenet i JSON-feltet access_token. Efter succes giver næste brug 401. Gentagne, ukendte eller fremmede tokens får samme revoked: true; andre nøglers tokens slettes aldrig.

const: true

Standard: trueEksempel: true

Yderligere felter: Nej