Datascheman: Autentisering

Datascheman: Autentisering. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Hämta · Token — Autentisering — Svar

ApiResponse_TokenData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataTokenData Obligatoriskt: Exempel på svar · TokenData.

Exempel: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt: Metadata för svaret.

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

Hämta · Token — Autentisering — Svar

TokenData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

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:00:00Z"
expires_inHeltalValfritt: 900 sekunder, alltså 15 minuter från utfärdandet. Anrop förlänger inte giltighetstiden.

Standardvärde: 900Exempel: 900
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":10,"read_per_minute":60,"write_per_minute":10}
token_typeSträngValfritt: Bearer. Autentiseringsschema för den returnerade token.

const: "Bearer"

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

Ytterligare fält: Nej

Anropsgränser

TokenRateLimitsData · 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. Noll betyder otillgängligt, inte obegränsat.

auth_per_minuteHeltalObligatoriskt: Tokenanrop per minut, inklusive misslyckade autentiseringsförsök.

minimum: 0maximum: 1000000

Exempel: 10
read_per_minuteHeltalObligatoriskt: Läsanrop per minut.

minimum: 0maximum: 1000000

Exempel: 60
write_per_minuteHeltalObligatoriskt: Skrivanrop per minut; värdet ger inte skrivbehörighet.

minimum: 0maximum: 1000000

Exempel: 10

Ytterligare fält: Nej

Hämta · Token — Autentisering — Begärans innehåll

TokenRequest · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

ObjektYtterligare fält: Nej

Ytterligare fält: Nej