Dataskjemaer: Autentisering

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"}

Ytterligere felt: Nei

dataTokenRevokedData Obligatorisk

Eksempel på svar · TokenRevokedData.

Eksempel: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorisk

Svarmetadata.

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

Ytterligere felt: Nei

access_tokenStrengObligatorisk

Token for headeren Authorization: Bearer. Angi SHOPENTLY_ACCESS_TOKEN før du kjører det separate eksemplet.

Eksempel: "EXAMPLE_ACCESS_TOKEN"

expires_atStrengObligatorisk

Utløpstidspunkt i UTC. Gjeldende tilgangsbegrensninger kan blokkere tokenet tidligere.

format: "date-time"

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

expires_inHeltallObligatorisk

Faktisk gyldighet i sekunder; dette eksemplet ber om 1800. Forespørsler forlenger den ikke. expires_at er utløpstidspunktet i UTC.

minimum: 300maximum: 3600

Eksempel: 1800

permissionsArray <Streng> Obligatorisk

permissions viser gjeldende effektive rettigheter: overlappen mellom nøkkelens, oppretterens og butikkabonnementets rettigheter, inkludert aktive tillegg. Tilgang kontrolleres ved hver forespørsel.

Eksempel: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obligatorisk

Engine ≥ 4.143.0. Hvert tokensvar inneholder data.rate_limits fra butikkens gjeldende policy ved utstedelsen. Alle nøkler deler disse budsjettene; et nytt token nullstiller dem ikke. En abonnementsendring kan gjelde før tokenet utløper.

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

token_typeStrengValgfritt

Bearer. Autentiseringsmetode for det returnerte tokenet.

const: "Bearer"

Standard: "Bearer"Eksempel: "Bearer"

warningsArray <TokenLifetimeWarning > Obligatorisk

Et heltall utenfor området bruker 900 sekunder og returnerer warnings med token.ttl_out_of_range og documentation_url til learn.shopently.com. Et utelatt felt gir ingen advarsel; feil type gir 422.

Eksempel: []

Ytterligere felt: Nei

applied_secondsHeltallValgfritt

900 s (15 min)

Standard: 900

codeStrengValgfritt

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Standard: "token.ttl_out_of_range"

documentation_urlStrengValgfritt

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

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

fieldStrengValgfritt

ttl_seconds

const: "ttl_seconds"

Standard: "ttl_seconds"

max_secondsHeltallValgfritt

3600 s (60 min)

Standard: 3600

messageStrengValgfritt

Et heltall utenfor området bruker 900 sekunder og returnerer warnings med token.ttl_out_of_range og documentation_url til learn.shopently.com. Et utelatt felt gir ingen advarsel; feil type gir 422.

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

min_secondsHeltallValgfritt

300 s (5 min)

Standard: 300

Ytterligere felt: Nei

auth_per_minuteHeltallObligatorisk

Forespørsler om utstedelse og tilbakekalling per minutt, inkludert mislykket autentisering. Begge deler auth-grensen.

minimum: 0maximum: 1000000

Eksempel: 1

read_per_minuteHeltallObligatorisk

Leseforespørsler per minutt.

minimum: 0maximum: 1000000

Eksempel: 2

write_per_minuteHeltallObligatorisk

Skriveforespørsler per minutt; verdien gir ikke skrivetilgang.

minimum: 0maximum: 1000000

Eksempel: 15

Ytterligere felt: Nei

ttl_secondsHeltallValgfritt

Valgfritt heltall ttl_seconds: 300–3600 sekunder (5–60 minutter). Uten feltet brukes standardverdien 900 sekunder (15 minutter).

Standard: 900Eksempel: 1800

Ytterligere felt: Nei

access_tokenStrengObligatorisk

Send POST /api/v1/auth/revoke med utstedernøkkelen i Authorization: ApiKey og tokenet i JSON-feltet access_token. Etter suksess gir neste bruk 401. Gjentatte, ukjente eller fremmede token får samme revoked: true; andre nøkler sine token slettes aldri.

minLength: 1maxLength: 256

Eksempel: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Ytterligere felt: Nei

revokedBoolsk verdiValgfritt

Send POST /api/v1/auth/revoke med utstedernøkkelen i Authorization: ApiKey og tokenet i JSON-feltet access_token. Etter suksess gir neste bruk 401. Gjentatte, ukjente eller fremmede token får samme revoked: true; andre nøkler sine token slettes aldri.

const: true

Standard: trueEksempel: true

Ytterligere felt: Nei