Datascheman: Autentisering

dataTokenData Obligatoriskt

Exempel på svar · TokenData.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

dataTokenRevokedData Obligatoriskt

Exempel på svar · TokenRevokedData.

Exempel: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

access_tokenSträngObligatoriskt

Token för headern Authorization: Bearer. Ange SHOPENTLY_ACCESS_TOKEN innan du kör det separata exemplet.

Exempel: "EXAMPLE_ACCESS_TOKEN"

expires_atSträngObligatoriskt

Utgångstid i UTC. Aktuella åtkomstbegränsningar kan blockera token tidigare.

format: "date-time"

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

expires_inHeltalObligatoriskt

Faktisk giltighetstid i sekunder; det här exemplet begär 1800. Anrop förlänger den inte. expires_at är utgångstiden i UTC.

minimum: 300maximum: 3600

Exempel: 1800

permissionsArray <Sträng> Obligatoriskt

permissions visar aktuella effektiva behörigheter: snittet mellan nyckelns, skaparens och butikens abonnemangsbehörigheter, inklusive aktiva tillägg. Åtkomst kontrolleras vid varje anrop.

Exempel: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obligatoriskt

Engine ≥ 4.143.0. Varje tokensvar innehåller data.rate_limits från butikens policy vid utfärdandet. Alla nycklar delar dessa budgetar; en ny token återställer dem inte. En planändring kan gälla innan token löper ut.

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

token_typeSträngValfritt

Bearer. Autentiseringsschema för den returnerade token.

const: "Bearer"

Standardvärde: "Bearer"Exempel: "Bearer"

warningsArray <TokenLifetimeWarning > Obligatoriskt

Ett heltal utanför intervallet ger 900 sekunder och returnerar warnings med token.ttl_out_of_range och documentation_url till learn.shopently.com. Ett utelämnat fält ger ingen varning; felaktig typ ger 422.

Exempel: []

Ytterligare fält: Nej

applied_secondsHeltalValfritt

900 s (15 min)

Standardvärde: 900

codeSträngValfritt

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Standardvärde: "token.ttl_out_of_range"

documentation_urlSträngValfritt

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

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

fieldSträngValfritt

ttl_seconds

const: "ttl_seconds"

Standardvärde: "ttl_seconds"

max_secondsHeltalValfritt

3600 s (60 min)

Standardvärde: 3600

messageSträngValfritt

Ett heltal utanför intervallet ger 900 sekunder och returnerar warnings med token.ttl_out_of_range och documentation_url till learn.shopently.com. Ett utelämnat fält ger ingen varning; felaktig typ ger 422.

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

min_secondsHeltalValfritt

300 s (5 min)

Standardvärde: 300

Ytterligare fält: Nej

auth_per_minuteHeltalObligatoriskt

Anrop för utfärdande och återkallande per minut, inklusive misslyckad autentisering. Båda delar auth-gränsen.

minimum: 0maximum: 1000000

Exempel: 1

read_per_minuteHeltalObligatoriskt

Läsanrop per minut.

minimum: 0maximum: 1000000

Exempel: 2

write_per_minuteHeltalObligatoriskt

Skrivanrop per minut; värdet ger inte skrivbehörighet.

minimum: 0maximum: 1000000

Exempel: 15

Ytterligare fält: Nej

ttl_secondsHeltalValfritt

Valfritt heltal ttl_seconds: 300–3600 sekunder (5–60 minuter). Utan fältet gäller standardvärdet 900 sekunder (15 minuter).

Standardvärde: 900Exempel: 1800

Ytterligare fält: Nej

access_tokenSträngObligatoriskt

Skicka POST /api/v1/auth/revoke med den utfärdande nyckeln i Authorization: ApiKey och token i JSON-fältet access_token. Efter framgång ger nästa användning 401. Upprepade, okända eller främmande token får samma revoked: true; andra nycklars token tas aldrig bort.

minLength: 1maxLength: 256

Exempel: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Ytterligare fält: Nej

revokedBooleskt värdeValfritt

Skicka POST /api/v1/auth/revoke med den utfärdande nyckeln i Authorization: ApiKey och token i JSON-fältet access_token. Efter framgång ger nästa användning 401. Upprepade, okända eller främmande token får samma revoked: true; andra nycklars token tas aldrig bort.

const: true

Standardvärde: trueExempel: true

Ytterligare fält: Nej